Class MutableDocumentPath

ReadonlymutableDocument

Readonlypath

attachmentToken

• get attachmentToken(): AttachmentToken

• Returns the value at the previously specified key in the document as a AttachmentToken if possible, otherwise returns null.

  Returns AttachmentToken

  Throws

  when called in a React Native environment.

counter

• get counter(): MutableCounter

• Returns the value at the previously specified key in the document as a MutableCounter if possible, otherwise returns null.

  Returns MutableCounter

  Throws

  when called in a React Native environment.

register

• get register(): MutableRegister

• Returns the value at the previously specified key in the document as a MutableRegister if possible, otherwise returns null.

  Returns MutableRegister

  Throws

  when called in a React Native environment.

value

• get value(): any

• Traverses the document with the key-path represented by the receiver and returns the corresponding object or value.

  Returns any

  Throws

  when called in a React Native environment.

at

• at(keyPathOrIndex): MutableDocumentPath

• Returns a new mutable document path instance with the passed in key-path or index appended.

  A key-path can be a single property name or multiple property names separated by a dot. Indexes can also be specified as part of the key path using square brackets syntax. The empty string returns a document path representing the same portion of the document as the receiver. If a key path starts with a property name and is prefixed by a dot, the dot is ignored.

  Examples:

  • mutableDocumentPath.at('mileage')
  • mutableDocumentPath.at('driver.name')
  • mutableDocumentPath.at('passengers[2]')
  • mutableDocumentPath.at('passengers[2].belongings[1].kind')
  • mutableDocumentPath.at('.mileage')

  Parameters

  • keyPathOrIndex: string | number

  Returns MutableDocumentPath

  Throws

  when called in a React Native environment.

remove

• remove(): void

• Removes a value at the document's key-path defined by the receiver.

  Returns void

  Throws

  when called in a React Native environment.

set

• set(value, isDefault?): void

• Sets a value at the document's key-path defined by the receiver.

  Parameters

  • value: any
  • OptionalisDefault: boolean

    Represents whether or not the value should be set as a default value. Set this to true if you want to set a default value that you expect to be overwritten by other devices in the network. The default value is false.

  Returns void

  Throws

  when called in a React Native environment.