Skip to main content

Interface: DomainModel

Defined in: packages/shared/lib/types.d.ts:153

Document-modelling types, re-exported from @docstack/shared.

These describe the values consumers have to construct themselves — most of all Patch, which StackOptions.patches asks for. @docstack/shared is an internal package, so surfacing them here is the only import path an application has.

Note that Document shadows the DOM's global Document in whichever module imports it; alias it (import type { Document as DocStackDocument }) in code that needs both.

Extends

Indexable

[key: string]: any

Properties

PropertyTypeOverridesInherited fromDefined in
_rev?string--packages/shared/lib/types.d.ts:160
~class"~self" | "domain"Document.~class-packages/shared/lib/types.d.ts:154
~createTimestamp?number-Document.~createTimestamppackages/shared/lib/types.d.ts:174
~domain?never-Document.~domainpackages/shared/lib/types.d.ts:201
~updateTimestamp?number-Document.~updateTimestamppackages/shared/lib/types.d.ts:175
active?boolean-Document.activepackages/shared/lib/types.d.ts:176
description?string--packages/shared/lib/types.d.ts:159
namestring--packages/shared/lib/types.d.ts:155
relation"1:1" | "1:N" | "N:1" | "N:N"--packages/shared/lib/types.d.ts:156
sourceClassstring--packages/shared/lib/types.d.ts:157
targetClassstring--packages/shared/lib/types.d.ts:158