Class WriteTransactionPendingIDSpecificOperation

These objects are returned when using findByID() functionality on collections.

You can either call exec() on the object to get an immediate return value, or chain calls to update, evict or remove the document.

Live queries and subscriptions are only available outside of a transaction.

Hierarchy

BasePendingIDSpecificOperation
- WriteTransactionPendingIDSpecificOperation

Index

Properties

collection documentID

Methods

evict exec remove update

Properties

`Readonly` collection

collection: CollectionInterface

The collection the receiver is operating on.

`Readonly` documentID

documentID: DocumentID

The ID of the document this operation operates on.

Methods

evict

evict(): Promise<boolean>
Evicts the document with the matching ID.

Returns Promise<boolean>
true promise if the document was found and evicted. false promise if the document wasn't found and therefore wasn't evicted.

Overrides BasePendingIDSpecificOperation.evict

exec

exec(): Promise<Document>
Executes the find operation to return the document with the matching ID.

Returns Promise<Document>
The Document promise with the ID provided in the findByID() call or undefined if the document was not found.

Inherited from BasePendingIDSpecificOperation.exec

remove

remove(): Promise<boolean>
Removes the document with the matching ID.

Returns Promise<boolean>
true promise if the document was found and removed. false promise if the document wasn't found and therefore wasn't removed.

Overrides BasePendingIDSpecificOperation.remove

update

update(closure): Promise<UpdateResult[]>
Updates the document with the matching ID.

Document values must not be set to any non-finite numbers (NaN, Infinity, -Infinity).
Parameters
- closure: ((document) => void)
  A closure that gets called with the document matching the ID. If found, the document is a MutableDocument, so you can call update-related functions on it. If the document is not found then the value provided to the closure will be undefined.
  - - (document): void
    - Parameters
      document: MutableDocument
      Returns void
Returns Promise<UpdateResult[]>
An array promise of update results that describe the updates that were performed on the document.

Overrides BasePendingIDSpecificOperation.update