Skip to content

Documentation / @super-line/server / Unsubscribe

Interface: Unsubscribe()

Defined in: index.ts:409

An unsubscribe function that also reports when its subscription became live on the wire.

Declaring interest and holding it are two different moments: the adapter has to reach a broker or a mesh before anything published elsewhere can arrive. ready closes that window for callers who publish immediately after subscribing — tests, mostly, since no real app subscribes and publishes in the same millisecond. It resolves immediately when the channel was already held.

It says the channel will now be delivered here. It does NOT say any peer has noticed: a gossip mesh may still be forming, and no adapter reports that.

Unsubscribe(): void

Defined in: index.ts:410

An unsubscribe function that also reports when its subscription became live on the wire.

Declaring interest and holding it are two different moments: the adapter has to reach a broker or a mesh before anything published elsewhere can arrive. ready closes that window for callers who publish immediately after subscribing — tests, mostly, since no real app subscribes and publishes in the same millisecond. It resolves immediately when the channel was already held.

It says the channel will now be delivered here. It does NOT say any peer has noticed: a gossip mesh may still be forming, and no adapter reports that.

Returns

void

Properties

ready

readonly ready: Promise<void>

Defined in: index.ts:411

Released under the MIT License.