The document this path belongs to.
The full document path so far.
Returns the value at the previously specified key in the document as a
AttachmentToken if possible, otherwise returns null.
Returns the value at the previously specified key in the document as a
Counter if possible, otherwise returns null.
Returns the value at the previously specified key in the document as a
Register if possible, otherwise returns null.
Returns the value at the previously specified key in the document as a
RGA if possible, otherwise returns null.
Traverses the document with the key path represented by the receiver and returns the corresponding object or value.
Returns a new 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:
documentPath.at('mileage')documentPath.at('driver.name')documentPath.at('passengers[2]')documentPath.at('passengers[2].belongings[1].kind')documentPath.at('.mileage')
Provides an interface to specify a path to a key in a document that you can then call a function on to get the value at the specified key as a specific type. You don't create a
DocumentPathdirectly but obtain one via theat()method of Document.