Provides information about a successful update operation on a document.

The update result can be one of the following types:

  • set
  • removed
  • incremented

Not available in React Native environments.

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

Properties

amount?: number

The associated amount, only set if type is incremented.

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

docID: DocumentID

The ID of the document that was updated.

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

path: string

The path to the key in the document that was updated.

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

The update result's type.

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

value?: any

The associated value for set operations. The value will be the new value at the key path.

All other types of update results do not have this property set.

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