Interface: Patch
Defined in: packages/shared/lib/types.d.ts:235
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
| Property | Type | Description | Overrides | Inherited from | Defined in |
|---|---|---|---|---|---|
~class | "patch" | - | Document.~class | - | packages/shared/lib/types.d.ts:236 |
~createTimestamp? | number | - | - | Document.~createTimestamp | packages/shared/lib/types.d.ts:174 |
~domain? | never | - | - | Document.~domain | packages/shared/lib/types.d.ts:201 |
~updateTimestamp? | number | - | - | Document.~updateTimestamp | packages/shared/lib/types.d.ts:175 |
active? | boolean | - | - | Document.active | packages/shared/lib/types.d.ts:176 |
changelog? | string | - | - | - | packages/shared/lib/types.d.ts:239 |
docs | ( | ExistingDocument<{ [key: string]: any; }> | Document<{ [key: string]: any; }>)[] | - | - | - | packages/shared/lib/types.d.ts:240 |
postApply? | PatchJob | Runs after the chain commit, in a second staged transaction, before the ledger arms (ADR-0044). | - | - | packages/shared/lib/types.d.ts:248 |
preApply? | PatchJob | Runs before this patch's docs stage, writes staged into the chain transaction (ADR-0044). | - | - | packages/shared/lib/types.d.ts:246 |
target | string | - | - | - | packages/shared/lib/types.d.ts:237 |
version | string | - | - | - | packages/shared/lib/types.d.ts:238 |