Interface TypedSubscriptionOptions<T>

Subscription Options

Type Parameters

  • T

Hierarchy

  • SubOpts<T>
    • TypedSubscriptionOptions

Properties

adapter callback? cleanupFn? dispatchedFn? ingestionFilterFn? max? protocolFilterFn? queue? timeout?

Properties

adapter

adapter: MsgAdapter<T>

Optional callback

callback?: TypedCallback<T>

Optional cleanupFn

cleanupFn?: ((sub: Subscription, info?: unknown) => void)

Type declaration

Optional dispatchedFn

dispatchedFn?: DispatchedFn<T>

Optional ingestionFilterFn

ingestionFilterFn?: IngestionFilterFn<T>

Optional max

max?: number

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

Optional protocolFilterFn

protocolFilterFn?: ProtocolFilterFn<T>

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