Interface NatsSubscriptionType

interface NatsSubscriptionType {
    isClosed: boolean;
    queue?: string;
    subject: string;
    [asyncIterator](): AsyncIterableIterator<NatsJsMsg>;
    drain(): Promise<void>;
    unsubscribe(): void;
}

Properties

isClosed queue? subject

Methods

[asyncIterator] drain unsubscribe

Properties

isClosed

isClosed: boolean

Indicates whether this subscription is currently active.

Optionalqueue

queue?: string

The queue group this subscription belongs to, if any.

subject

subject: string

The subject this subscription is listening to.

Methods

[asyncIterator]

drain

  • drain(): Promise<void>

  • Drains the subscription, ensuring all pending messages are delivered before unsubscribing.

    Returns Promise<void>

    Promise

unsubscribe

  • unsubscribe(): void

  • Unsubscribes from the subject, stopping message delivery.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods