A live pub/sub subscription from ApiClient.subscribe: iterate it once with for await for the events, in arrival order; end it with close() or await using.

interface Subscription {
    "[asyncDispose]"(): Promise<void>;
    close(): void;
}

Hierarchy

Methods

  • await using support: same as Subscription.close.

    Returns Promise<void>

  • Ends the subscription (aborts the stream); the iteration ends cleanly. Idempotent.

    Returns void