Class Document

A document belonging to a Collection with an inner value.

Accessors

id path value

Methods

at hash hashMnemonic

Accessors

id

path

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

Methods

at

  • at(keyPathOrIndex): DocumentPath

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

    Parameters

    • keyPathOrIndex: string | number

    Returns DocumentPath

Static hash

  • hash(documentOrMany): BigInt

  • Returns a hash that represents the passed in document(s).

    Parameters

    Returns BigInt

Static hashMnemonic

  • hashMnemonic(documentOrMany): string

  • Returns a pattern of words that together create a mnemonic, which represents the passed in document(s).

    Parameters

    Returns string

Settings

Member Visibility

Theme

On This Page