Interface CreateChannelOpts

interface CreateChannelOpts {
    confirm?: boolean;
    json?: boolean;
    name?: string;
    publishTimeout?: number;
    setup?: SetupFunc;
}

Properties

confirm? json? name? publishTimeout? setup?

Properties

Optional confirm

confirm?: boolean

True to create a ConfirmChannel (default). False to create a regular Channel.

Optional json

json?: boolean

if true, then ChannelWrapper assumes all messages passed to publish() and sendToQueue() are plain JSON objects. These will be encoded automatically before being sent.

Optional name

name?: string

Name for this channel. Used for debugging.

Optional publishTimeout

publishTimeout?: number

Default publish timeout in ms. Messages not published within the given time are rejected with a timeout error.

Optional setup

setup?: SetupFunc

A function to call whenever we reconnect to the broker (and therefore create a new underlying channel.) This function should either accept a callback, or return a Promise. See addSetup below

Settings

Member Visibility

Theme

On This Page

confirmjsonnamepublishTimeoutsetup