haredo

    Interface HaredoMessage<T>

    interface HaredoMessage<T = unknown> {
        _type: "HaredoMessage";
        appId?: string;
        consumerTag?: string;
        contentEncoding?: string;
        contentType?: string;
        correlationId?: string;
        data: T;
        dataString: null | string;
        deliveryCount: undefined | number;
        deliveryMode?: 1 | 2;
        deliveryTag: number;
        emitter: TypedEventEmitter<HaredoMessageEvents>;
        exchange?: string;
        expiration?: number;
        headers: undefined | Record<string, Field>;
        messageId?: string;
        priority?: number;
        queue: string;
        raw: AMQPMessage;
        redelivered: boolean;
        replyTo?: string;
        routingKey?: string;
        streamOffset?: number;
        timestamp?: Date;
        type?: string;
        userId?: string;
        ack(): Promise<void>;
        getHeader<TFIELD = Field>(header: string): TFIELD;
        isAcked(): boolean;
        isHandled(): boolean;
        isNacked(): boolean;
        nack(requeue?: boolean): Promise<void>;
    }

    Type Parameters

    • T = unknown

    Hierarchy (View Summary)

    Index

    Properties

    _type appId? consumerTag? contentEncoding? contentType? correlationId? data dataString deliveryCount deliveryMode? deliveryTag emitter exchange? expiration? headers messageId? priority? queue raw redelivered replyTo? routingKey? streamOffset? timestamp? type? userId?

    Methods

    ack getHeader isAcked isHandled isNacked nack

    Properties

    _type

    _type: "HaredoMessage"
    appId?: string

    An arbitrary identifier for the originating application

    consumerTag?: string

    consumerTag of the consumer the message originates from

    contentEncoding?: string
    contentType?: string
    correlationId?: string

    Used for RPC system to match messages to their replies

    data: T

    Message contents

    dataString: null | string

    Unparsed message data

    deliveryCount: undefined | number

    Amount of attempts the broker has done to deliver the message. undefined on first attempt

    deliveryMode?: 1 | 2

    Either 1 for non-persistent or 2 for persistent

    deliveryTag: number

    deliveryTag of the message (used to identify the message between consumer and broker)

    emitter: TypedEventEmitter<HaredoMessageEvents>
    exchange?: string

    Name of the exchange the message originates from

    expiration?: number

    If supplied, the message will be discarded from a queue once it's been there longer than the given number of milliseconds

    headers: undefined | Record<string, Field>

    Headers of the message

    messageId?: string

    Arbitrary application-specific identifier for the message

    priority?: number

    Priority of a message. See priority queues

    queue: string

    Name of the queue this message was consumed from

    raw: AMQPMessage
    redelivered: boolean

    True if the message has been sent to a consumer at least once

    replyTo?: string

    Queue name to reply to for RPC

    routingKey?: string

    Routingkey. If routingkey was not set then this equals to the name of the queue

    streamOffset?: number

    Stream offset of the message. Only available for streams

    timestamp?: Date

    A timestamp for the message. Rounded to the nearest second when provided

    type?: string

    An arbitrary application-specific type for the message

    userId?: string

    If supplied, RabbitMQ will compare it to the username supplied when opening the connection, and reject messages for which it does not match

    Methods

    • Nack the message. If requeue is false (defaults to true) then the message will be discarded. Otherwise it will be returned to the front of the queue

      Parameters

      • Optionalrequeue: boolean

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    MMNEPVFCICPMFPCPTTAAATR