Class: DocumentAcknowledgement

ReactiveDb.DocumentAcknowledgement

Represents the acknowledgement of a document within a query.

A document is acknowledged when only its acknowledgement status is updated from 0 (document not acknowledged) to a value other than 0 (document partially or fully acknowledged).

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

Extends

Members

(readonly) doc :ReactiveDb.Document

Document associated with this instance.

It represents the state of the document just after the change, except for document removals where it represents its state juste before its removal from the query.

Type:
Overrides:

Methods

isAcknowledgement() → {boolean}

Checks whether this instance represents the acknowledgement of a document within a query.

Overrides:
Returns:
Type
boolean

isAddition() → {boolean}

Checks whether this instance represents the addition of a document into a query.

Overrides:
Returns:
Type
boolean

isMove() → {boolean}

Checks whether this instance represents the move of a document within a query.

Overrides:
Returns:
Type
boolean

isRemoval() → {boolean}

Checks whether this instance represents the removal of a document from a query.

Overrides:
Returns:
Type
boolean

isUpdate() → {boolean}

Checks whether this instance represents the update of a document within a query.

Overrides:
Returns:
Type
boolean
deprecated
Authentication
ServerlessDb
ReactiveDb