Interface: QueryNotification

ReactiveDb.QueryNotification

Represents a notification received by a ReactiveDb.Watcher objet when the content of a query has changed (either locally or remotely).

Extends

Members

(readonly) changes :Array.<ReactiveDb.DocumentChange>

The (ordered and generally non-empty) list of changes on the documents matched by the query associated to this notification, which occurred since the last sent notification.

Type:

(readonly) documents :Array.<ReactiveDb.Document>

Gives the (ordered and possibly empty) list of all documents contained in this query result.

Type:
Inherited From:

(readonly) fromServer :boolean

Indicates whether this query result comes from the Webcom back end (true) or the local cache (false).

Type:
  • boolean
Inherited From:

(readonly) query :ReactiveDb.Queryable

The query corresponding to this notification.

Type:

Methods

isAcknowledgement() → {boolean}

Indicates whether this notification is a pure acknowledgement event from the back end. If so, the associated changes only contain ReactiveDb.DocumentAcknowledgement instances or are empty.

This kind of notification may be filtered out from the subscription by setting the WatchOptions#watchAcks property to false when subscribing with the ReactiveDb#watchOne or ReactiveDb#watchMany methods.

Returns:
Type
boolean
deprecated
Authentication
ServerlessDb
ReactiveDb