Class BasePendingIDSpecificOperationAbstract

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.

Not available in React Native environments.

Hierarchy (view full)

Implements

Properties

collection documentID

Methods

evict exec remove update updateV2

Properties

Readonlycollection

collection: CollectionInterface

The collection the receiver is operating on.

ReadonlydocumentID

documentID: DocumentID

The ID of the document this operation operates on.

Methods

Abstractevict

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

    Throws

    when called in a React Native environment.

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.

    Throws

    when called in a React Native environment.

Abstractremove

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

    Throws

    when called in a React Native environment.

Abstractupdate

  • 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: MutableDocument) => 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. The closure is not called if the document is not found.

    Returns Promise<UpdateResult[]>

    An array promise of update results that describe the updates that were performed on the document.

    Throws

    Error if the document is not found.

    Deprecated

    This method throws and does not call the closure if the document is not found. Use updateV2() instead.

AbstractupdateV2

  • updateV2(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?: MutableDocument) => 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.

    Returns Promise<UpdateResult[]>

    An array promise of update results that describe the updates that were performed on the document.

    Throws

    when called in a React Native environment.

Settings

Member Visibility

On This Page

Properties
Methods