A representation of a Document that can be mutated via MutableDocumentPath. You don't create or interact with a MutableDocument directly but rather through the update() methods of PendingCursorOperation and PendingIDSpecificOperation.

Not available in React Native environments.

Accessors

Methods

Accessors

  • get id(): DocumentID
  • Returns the ID of the document.

    Returns DocumentID

    when called in a React Native environment.

  • get value(): DocumentValue
  • Convenience property, same as path.value.

    Returns DocumentValue

    when called in a React Native environment.

Methods

  • Convenience method, same as calling path.at().

    Parameters

    • keyPathOrIndex: string | number

    Returns MutableDocumentPath

    when called in a React Native environment.