Interface TypedSubscriptionOptions<T>

Subscription Options

interface TypedSubscriptionOptions<T> {
    adapter: MsgAdapter<T>;
    callback?: TypedCallback<T>;
    cleanupFn?: ((sub: Subscription, info?: unknown) => void);
    dispatchedFn?: DispatchedFn<T>;
    ingestionFilterFn?: IngestionFilterFn<T>;
    max?: number;
    protocolFilterFn?: ProtocolFilterFn<T>;
    queue?: string;
    timeout?: number;
}

Type Parameters

  • T

Hierarchy (view full)

Properties

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

Properties

adapter

adapter: MsgAdapter<T>

Optionalcallback

callback?: TypedCallback<T>

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.

Param: err

Param: msg

OptionalcleanupFn

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

OptionaldispatchedFn

dispatchedFn?: DispatchedFn<T>

OptionalingestionFilterFn

ingestionFilterFn?: IngestionFilterFn<T>

Optionalmax

max?: number

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

OptionalprotocolFilterFn

protocolFilterFn?: ProtocolFilterFn<T>

Optionalqueue

queue?: string

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

Optionaltimeout

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

On This Page

Properties