Class BasePendingIDSpecificOperationAbstract

Readonly collection

Readonly documentID

Abstract 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.

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.

Abstract 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.

Abstract update

• update(closure): Promise<UpdateResult[]>

• Updates the document with the matching ID.

  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.