Class SyncSubscription

A sync subscription configures Ditto to receive updates from remote peers about documents matching the subscription's query.

The sync subscription will remain active until it is cancelled, or the Ditto instance managing the subscription has been closed.

Create a sync subscription by calling ditto.sync.registerSubscription().

Hierarchy

  • SyncSubscription

Properties

ditto queryArguments? queryString

Accessors

isCancelled

Methods

cancel

Properties

Readonly ditto

ditto: Ditto

The Ditto instance this sync subscription belongs to.

Optional Readonly queryArguments

queryArguments?: Readonly<DQLQueryArguments>

The query arguments of the sync subscription (as passed when adding it to the store).

Readonly queryString

queryString: string

Documents matching this query will be included in the sync subscription.

Accessors

isCancelled

  • get isCancelled(): boolean

  • true when the sync subscription has been cancelled or the Ditto instance managing this subscription has been closed.

    Returns boolean

Methods

cancel

  • Cancels the sync subscription and unregisters it. No-op if the sync subscription has already been cancelled or the Ditto instance managing this subscription has been closed.

    Returns void

Settings

Member Visibility

Theme

On This Page