Documentation / @super-line/client / Subscription

Interface: Subscription

Defined in: packages/client/src/index.ts:36

A topic subscription handle returned by client.subscribe.

Properties

ready

readonly ready: Promise<void>

Defined in: packages/client/src/index.ts:38

Resolves when the server acknowledges the subscribe; rejects if denied or disconnected.

Methods

unsubscribe()

unsubscribe(): void

Defined in: packages/client/src/index.ts:40

Stop receiving the topic and tell the server to unsubscribe.

Returns

void