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

Properties

The collection the receiver is operating on.

documentID: DocumentID

The ID of the document this operation operates on.

Methods

  • Evicts the document with the matching ID.

    Returns

    true promise if the document was found and evicted. false promise if the document wasn't found and therefore wasn't evicted.

    Returns Promise<boolean>

  • Removes the document with the matching ID.

    Returns

    true promise if the document was found and removed. false promise if the document wasn't found and therefore wasn't removed.

    Returns Promise<boolean>