Class WriteTransactionPendingIDSpecificOperation

Deprecated

Use DQL (Ditto Query Language) instead. For more information see: https://ditto.com/link/dql-legacy-to-dql-adoption

Hierarchy (view full)

BasePendingIDSpecificOperation
- WriteTransactionPendingIDSpecificOperation

Index

Properties

collection documentID

Methods

evict exec remove update updateV2

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.

Throws
when called in a React Native environment.

Deprecated
Use DQL (Ditto Query Language) instead. For more information see: https://ditto.com/link/dql-legacy-to-dql-adoption

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.

Throws
when called in a React Native environment.

Deprecated
Use DQL (Ditto Query Language) instead. For more information see: https://ditto.com/link/dql-legacy-to-dql-adoption

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

Throws
when called in a React Native environment.

Deprecated
Use DQL (Ditto Query Language) instead. For more information see: https://ditto.com/link/dql-legacy-to-dql-adoption

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: 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.
  - - (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.

Throws
Error if the document is not found.

Deprecated
Use DQL (Ditto Query Language) instead. For more information see: https://ditto.com/link/dql-legacy-to-dql-adoption

Overrides BasePendingIDSpecificOperation.update

updateV2

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.
  - - (document?): void
    - Parameters
      Optionaldocument: MutableDocument
      Returns void
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.

Deprecated
Use DQL (Ditto Query Language) instead. For more information see: https://ditto.com/link/dql-legacy-to-dql-adoption

Overrides BasePendingIDSpecificOperation.updateV2