Class Subscription

Used to subscribe to receive updates from remote peers about matching documents.

While Subscription objects remain in scope they ensure that documents in the collection specified and that match the query provided will try to be kept up-to-date with the latest changes from remote peers.

Hierarchy

Subscription

Index

Properties

Accessors

collectionName isCancelled

Methods

Properties

`Readonly` query

query: string

The query that the subscription is based on.

Accessors

collectionName

get collectionName(): string
The name of the collection that the subscription is based on.

Returns string

isCancelled

get isCancelled(): boolean
Returns true if subscription has been explicitly cancelled, false otherwise.

Returns boolean

Methods

cancel

cancel(): void
Cancels a subscription and releases all associated resources.

Returns void