Interface HeaderFields

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

Hierarchy

Properties

appId?: string

Creating application id.

clusterId?: string
contentEncoding?: string

MIME content encoding. e.g. "gzip"

contentType?: string

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

correlationId?: string

Application correlation identifier.

durable?: boolean

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

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.

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

Additional user-defined fields

Type declaration

messageId?: string

Application message identifier.

priority?: number

Message priority, 0 to 9.

replyTo?: string
timestamp?: number

Message timestamp in seconds.

type?: string

Message type name.

userId?: string

Creating user id.

Generated using TypeDoc