Interface Envelope

interface Envelope {
    appId?: string;
    clusterId?: string;
    contentEncoding?: string;
    contentType?: string;
    correlationId?: string;
    durable?: boolean;
    exchange?: string;
    expiration?: string;
    headers?: {
        BCC?: string[];
        CC?: string[];
        [k: string]: any;
    };
    immediate?: string;
    mandatory?: boolean;
    messageId?: string;
    priority?: number;
    replyTo?: string;
    routingKey?: string;
    timestamp?: number;
    type?: string;
    userId?: string;
}

Hierarchy

Properties

appId? clusterId? contentEncoding? contentType? correlationId? durable? exchange? expiration? headers? immediate? mandatory? messageId? priority? replyTo? routingKey? timestamp? type? userId?

Properties

Optional appId

appId?: string

Creating application id.

Optional clusterId

clusterId?: string

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.

Optional durable

durable?: boolean

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

Optional exchange

exchange?: string

Specifies the name of the exchange to publish to. The exchange name can be empty, meaning the default exchange. If the exchange name is specified, and that exchange does not exist, the server will raise a channel exception.

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 immediate

immediate?: string

This flag tells the server how to react if the message cannot be routed to a queue consumer immediately. If this flag is set, the server will return an undeliverable message with a Return method. If this flag is zero, the server will queue the message, but with no guarantee that it will ever be consumed.

Optional mandatory

mandatory?: boolean

This flag tells the server how to react if the message cannot be routed to a queue. If this flag is set, the server will return an unroutable message with a Return method. If this flag is zero, the server silently drops the message.

Optional messageId

messageId?: string

Application message identifier.

Optional priority

priority?: number

Message priority, 0 to 9.

Optional replyTo

replyTo?: string

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

Optional routingKey

routingKey?: string

Specifies the routing key for the message. The routing key is used for routing messages depending on the exchange configuration.

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