Skip to content

@vttforge/core / EmbeddedDocumentFieldInstance

Interface: EmbeddedDocumentFieldInstance<Doc, O>

A single embedded document, stored inline.

Like EmbeddedDataField but for a Document class, and nullable by default: the field's own defaults turn nullable on, so an absent one reads null.

Extends

Type Parameters

Doc

Doc extends DataModelClass = DataModelClass

O

O extends EmbeddedDocumentFieldOptions = EmbeddedDocumentFieldOptions

Properties

[BRAND]

readonly [BRAND]: "embeddedDocument"

Overrides

FieldInstance.[BRAND]


model

readonly model: Doc


options

readonly options: O

Overrides

FieldInstance.options

MIT licensed.