Class MutableDocument

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.

Deprecated

Use DQL (Ditto Query Language) instead. For more information see: https://ditto.com/link/dql-legacy-to-dql-adoption

Index

Accessors

Methods

Accessors

id

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

Returns DocumentID
Throws
when called in a React Native environment.

Deprecated
Use DQL (Ditto Query Language) instead. For more information see: https://ditto.com/link/dql-legacy-to-dql-adoption

path

get path(): MutableDocumentPath
Returns the document path at the root of the document.

Returns MutableDocumentPath
Throws
when called in a React Native environment.

Deprecated
Use DQL (Ditto Query Language) instead. For more information see: https://ditto.com/link/dql-legacy-to-dql-adoption

value

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

Returns DocumentValue
Throws
when called in a React Native environment.

Deprecated
Use DQL (Ditto Query Language) instead. For more information see: https://ditto.com/link/dql-legacy-to-dql-adoption

Methods

at

at(keyPathOrIndex): MutableDocumentPath
Convenience method, same as calling path.at().
Parameters
- keyPathOrIndex: string | number
Returns MutableDocumentPath
Throws
when called in a React Native environment.

Deprecated
Use DQL (Ditto Query Language) instead. For more information see: https://ditto.com/link/dql-legacy-to-dql-adoption