Interface SubOpts<T>

Subscription Options

Type Parameters

  • T

Hierarchy

Properties

callback? max? queue? timeout?

Properties

Optional callback

callback?: ((err: NatsError, msg: T) => void)

Type declaration

    • (err: NatsError, msg: T): 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

      Returns void

Optional max

max?: number

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

Optional queue

queue?: string

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

Optional 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.

Settings

Member Visibility

Theme

Generated using TypeDoc