Interface EntitySubscription

interface EntitySubscription {
    sid: number;
    close(): void;
    onEnd(handler: EntitySubscriptionEndHandler): () => void;
}

Hierarchy

EntitySubscription
- CommunityProjectionSubscription
- EntityQuerySubscription

Index

Properties

Methods

Properties

`Readonly`sid

sid: number

The project-local stream id.

Methods

close

close(): void

Tear down the subscription and post end to the host. Idempotent.

Returns void

onEnd

onEnd(handler: EntitySubscriptionEndHandler): () => void
Run handler when the host (or a revoke/crash) ends this stream.
Parameters
- handler: EntitySubscriptionEndHandler
Returns () => void