Class UpdateResult

Hierarchy

  • UpdateResult

Properties

amount? docID path type value?

Properties

Optional Readonly amount

amount?: number

The associated amount, only set if type is incremented.

Readonly docID

docID: DocumentID

The ID of the document that was updated.

Readonly path

path: string

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

Readonly type

type: UpdateResultType

The update result's type.

Optional Readonly value

value?: any

The associated value with different meaning depending on the type:

  • For type set, it's the new value at the key path.
  • For type inserted, it's the new value that was inserted into the array at index encoded into key path.
  • For type pushed, it's the new value that was inserted into the array at key path.
  • For type popped, it's the value that was popped off the array the key path.

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

Settings

Member Visibility

Theme