Class: DocumentField

ReactiveDb.DocumentField

Represents the field of a document.

To build fields referring to the user data, use the data factory.
To build fields referring to meta-data, use one of the id, createdAt, updatedAt or version factories.

All these factories can be accessed using the DocumentField property of the Webcom.ReactiveDb static property.

Members

(static, readonly) createdAt :ReactiveDb.DocumentField

Creates a DocumentField instance referring to the createdAt metadata field, which represents the document creation date.

Type:

(static, readonly) id :ReactiveDb.DocumentField

Creates a DocumentField instance referring to the id metadata field, which represents the document identifier.

Type:

(static, readonly) updatedAt :ReactiveDb.DocumentField

Creates a DocumentField instance referring to the updatedAt metadata field, which represents the document last modification date.

Type:

(static, readonly) version :ReactiveDb.DocumentField

Creates a DocumentField instance referring to the version metadata field, which represents the document version.

Type:

Methods

(static) data(…segments) → {ReactiveDb.DocumentField}

Creates a DocumentField instance referring to a field of the user data of the document.

Parameters:
Name Type Attributes Description
segments string <repeatable>

Ordered list of segments to reach the referred field. Each segment represents a key (or a sub-key) within the JSON content of the document.
Warning! each specified field must not contain the "." character.

Returns:
Type
ReactiveDb.DocumentField
deprecated
Authentication
ServerlessDb
ReactiveDb