Class: DocumentMove

ReactiveDb.DocumentMove

Represents the move of a document within a query.

A document is moved when its rank within the list of matched documents changes. This typically happens when some other document of the query have changed and is now ordered before the moved document.

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:

(readonly) from :number

Rank of the moved document (in the document list associated with the query) BEFORE its move.

Type:
  • number

(readonly) to :number

Rank of the moved document (in the document list associated with the query) AFTER its move.

Type:
  • number

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