Interface EntityQuerySubscription<T>

interface EntityQuerySubscription<T = unknown> {
    sid: number;
    close(): void;
    onEnd(handler: EntitySubscriptionEndHandler): () => void;
}

Type Parameters

T = unknown

Hierarchy

EntitySubscription
- 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

Inherited from EntitySubscription.close

onEnd

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

Inherited from EntitySubscription.onEnd