Class Document

A document belonging to a Collection with an inner value.

Hierarchy

Document

Index

Properties

Methods

Properties

Readonly _id

_id: DocumentID

Returns the ID of the document.

Readonly _pathAt

_pathAt: (key: string) => DocumentPath

Type declaration

- (key: string): DocumentPath
- Returns the document path at a specified key.
  
  Parameters
  - key: string
  Returns DocumentPath

Readonly _value

_value: DocumentValue

Returns the content (aka value) of the document.

Readonly _valueAt

_valueAt: (path: string) => any

Type declaration

- (path: string): any
- Returns the content (aka inner value) of a document at the given path.
  
  Parameters
  - path: string
  Returns any

Methods

Static hash

hash(documentOrMany: any): BigInt

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

Parameters
- documentOrMany: any
Returns BigInt

Static hashMnemonic

hashMnemonic(documentOrMany: any): string

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

Parameters
- documentOrMany: any
Returns string

Static id

id(document: any): DocumentID

Returns the ID for a document.

Parameters
- document: any
Returns DocumentID

Static pathAt

pathAt(document: any, keyPath: string, skipValidation?: boolean): DocumentPath

Returns a document path object for a given key for a document.

Parameters
- document: any
- keyPath: string
- Optional skipValidation: boolean
Returns DocumentPath

Static value

value(document: any): DocumentValue

Returns the content (aka inner value) of a document.

Parameters
- document: any
Returns DocumentValue

Static valueAt

valueAt(document: any, path: string): any

Returns the content (aka inner value) of a document at the given path.

Parameters
- document: any
- path: string
Returns any