Interface AsyncMessage

May be received after creating a consumer with Channel.basicConsume

interface AsyncMessage {
    appId?: string;
    body: any;
    clusterId?: string;
    consumerTag: string;
    contentEncoding?: string;
    contentType?: string;
    correlationId?: string;
    deliveryTag: number;
    durable?: boolean;
    exchange: string;
    expiration?: string;
    headers?: {
        BCC?: string[];
        CC?: string[];
        [k: string]: any;
    };
    messageId?: string;
    priority?: number;
    redelivered: boolean;
    replyTo?: string;
    routingKey: string;
    timestamp?: number;
    type?: string;
    userId?: string;
}

Hierarchy

Properties

appId? body clusterId? consumerTag contentEncoding? contentType? correlationId? deliveryTag durable? exchange expiration? headers? messageId? priority? redelivered replyTo? routingKey timestamp? type? userId?

Properties

Optional appId

appId?: string

Creating application id.

body

body: any

Optional clusterId

clusterId?: string

consumerTag

consumerTag: string

Identifier for the consumer, valid within the current channel.

Optional contentEncoding

contentEncoding?: string

MIME content encoding. e.g. "gzip"

Optional contentType

contentType?: string

MIME content type. e.g. "application/json"

Optional correlationId

correlationId?: string

Application correlation identifier.

deliveryTag

deliveryTag: number

The server-assigned and channel-specific delivery tag

Optional durable

durable?: boolean

Alias for "deliveryMode". Published message should be saved to disk and should survive server restarts.

exchange

exchange: string

Specifies the name of the exchange that the message was originally published to. May be empty, indicating the default exchange.

Optional expiration

expiration?: string

Message TTL, in milliseconds. Note that only when expired messages reach the head of a queue will they actually be discarded (or dead-lettered). Setting the TTL to 0 causes messages to be expired upon reaching a queue unless they can be delivered to a consumer immediately.

Optional headers

headers?: {
    BCC?: string[];
    CC?: string[];
    [k: string]: any;
}

Additional user-defined fields

Type declaration

Optional messageId

messageId?: string

Application message identifier.

Optional priority

priority?: number

Message priority, 0 to 9.

redelivered

redelivered: boolean

True if the message has been previously delivered to this or another client.

Optional replyTo

replyTo?: string

https://www.rabbitmq.com/direct-reply-to.html

routingKey

routingKey: string

The routing key name specified when the message was published.

Optional timestamp

timestamp?: number

Message timestamp in seconds.

Optional type

type?: string

Message type name.

Optional userId

userId?: string

Creating user id.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc