Interface Subscription<TOutgoing, TIncoming>

A live WebSocket subscription handle returned by client.group.endpoint().

Implements AsyncIterable for consuming server-sent events and provides send() for client→server messages when the subscription is bidirectional.

interface Subscription<TOutgoing, TIncoming = never> {
    state: "connecting" | "connected" | "reconnecting" | "closed";
    "[asyncIterator]"(): AsyncIterator<TOutgoing, any, any>;
    close(): void;
    send(message: TIncoming): void;
}

Type Parameters

TOutgoing
TIncoming = never

Hierarchy

AsyncIterable<TOutgoing>
- Subscription

Index

Properties

Methods

[asyncIterator] close send

Properties

`Readonly`state

state: "connecting" | "connected" | "reconnecting" | "closed"

Current connection state.

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<TOutgoing, any, any>
Returns AsyncIterator<TOutgoing, any, any>
Inherited from AsyncIterable.[asyncIterator]
- Defined in node_modules/typescript/lib/lib.es2018.asynciterable.d.ts:36

close

close(): void
Gracefully close the WebSocket connection.

Returns void
- Defined in libs/client/src/types.ts:407

send

send(message: TIncoming): void
Send a message to the server. Only available on bidirectional subscriptions.
Parameters
- message: TIncoming
Returns void
- Defined in libs/client/src/types.ts:405