Interface PublisherProps

Hierarchy

  • PublisherProps

Properties

confirm? exchangeBindings? exchanges? maxAttempts? onReturn? queueBindings? queues?

Properties

Optional confirm

confirm?: boolean

Enable publish-confirm mode. See confirmSelect

Optional exchangeBindings

exchangeBindings?: {
    arguments?: Record<string, any>;
    destination: string;
    routingKey?: string;
    source: string;
}[]

Define any exchange-exchange bindings to be declared before the first publish and whenever the connection is reset. Same as Channel#exchangeBind()

Optional exchanges

exchanges?: {
    arguments?: {
        alternate-exchange?: string;
        [k: string]: any;
    };
    autoDelete?: boolean;
    durable?: boolean;
    exchange: string;
    internal?: boolean;
    passive?: boolean;
    type?: string;
}[]

Define any exchanges to be declared before the first publish and whenever the connection is reset. Same as Channel#exchangeDeclare()

Optional maxAttempts

maxAttempts?: number

Maximum publish attempts. Retries are disabled by default. Increase this number to retry when a publish fails. The Connection options acquireTimeout, retryLow, and retryHigh will affect time between retries. Each failed attempt will also emit a "retry" event.

Default

1

Optional onReturn

onReturn?: ((msg) => void)

Type declaration

Optional queueBindings

queueBindings?: {
    arguments?: Record<string, any>;
    exchange: string;
    queue?: string;
    routingKey?: string;
}[]

Define any queue-exchange bindings to be declared before the first publish and whenever the connection is reset. Same as Channel#queueBind()

Optional queues

queues?: {
    arguments?: {
        x-dead-letter-exchange?: string;
        x-dead-letter-routing-key?: string;
        x-expires?: number;
        x-max-length?: number;
        x-max-priority?: number;
        x-message-ttl?: number;
        x-overflow?: "drop-head" | "reject-publish" | "reject-publish-dlx";
        x-queue-type?: "quorum" | "classic" | "stream";
        [k: string]: any;
    };
    autoDelete?: boolean;
    durable?: boolean;
    exclusive?: boolean;
    passive?: boolean;
    queue?: string;
}[]

Define any queues to be declared before the first publish and whenever the connection is reset. Same as Channel#queueDeclare()

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc