SubOpts

Subscription Options

Type parameters¶

• T

Properties¶

callback?¶

callback?: (err, msg) => void

An optional function that will handle messages. Typically, messages are processed via an async iterator on the subscription. If this option is provided, messages are processed by the specified function.

Parameters¶

• err: null | NatsError

• msg: T

Returns¶

void

max?¶

max?: number

Optional maximum number of messages to deliver to the subscription before it is auto-unsubscribed.

queue?¶

queue?: string

Optional queue name (subscriptions on the same subject that use queues are horizontally load balanced when part of the same queue).

timeout?¶

timeout?: number

Optional maximum number of milliseconds before a timer raises an error. This useful to monitor a subscription that is expected to yield messages. The timer is cancelled when the first message is received by the subscription.