Class Document

A document belonging to a Collection with an inner value.

Not available in React Native environments.

Index

Accessors

Methods

at hash hashMnemonic

Accessors

id

get id(): DocumentID
Returns the document ID.

Returns DocumentID
Throws
when called in a React Native environment.

path

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

Returns DocumentPath
Throws
when called in a React Native environment.

value

get value(): DocumentValue
Convenience property, same as calling path.value. The value is cached on first access and returned on subsequent calls without calling path.value again.

Returns DocumentValue
Throws
when called in a React Native environment.

Methods

at

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

`Static`hash

hash(documentOrMany): BigInt
Returns a hash that represents the passed in document(s).
Parameters
- documentOrMany: Document | Document[]
Returns BigInt
Throws
when called in a React Native environment.

`Static`hashMnemonic

hashMnemonic(documentOrMany): string
Returns a pattern of words that together create a mnemonic, which represents the passed in document(s).
Parameters
- documentOrMany: Document | Document[]
Returns string
Throws
when called in a React Native environment.