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.

Properties

amount?: number

The associated amount, only set if type is incremented.

docID: DocumentID

The ID of the document that was updated.

path: string

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

The update result's type.

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.