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

Properties

Accessors

Methods

Properties

isCancelled: false = false

Returns true if subscription has been explicitly cancelled, false otherwise.

query: string

The query that the subscription is based on.

Accessors

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

    Returns string

Methods

  • Cancels a subscription and releases all associated resources.

    Returns void