Skip to main content

Interface: Patch

Defined in: shared/lib/types.d.ts:235

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

Sourced from the client rather than @docstack/shared on purpose: the two packages would otherwise resolve their own copies of @docstack/shared, and a consumer using both could end up holding two structurally-identical-but-distinct Patch types. One source means one copy.

Extends

Indexable

[key: string]: any

Properties

PropertyTypeDescriptionOverridesInherited fromDefined in
~class"patch"-Document.~class-shared/lib/types.d.ts:236
~createTimestamp?number--Document.~createTimestampshared/lib/types.d.ts:174
~domain?undefined--Document.~domainshared/lib/types.d.ts:201
~updateTimestamp?number | null--Document.~updateTimestampshared/lib/types.d.ts:175
active?boolean--Document.activeshared/lib/types.d.ts:176
changelog?string---shared/lib/types.d.ts:239
docs( | ExistingDocument<{ [key: string]: any; }> | Document<{ [key: string]: any; }>)[]---shared/lib/types.d.ts:240
postApply?PatchJobRuns after the chain commit, in a second staged transaction, before the ledger arms (ADR-0044).--shared/lib/types.d.ts:248
preApply?PatchJobRuns before this patch's docs stage, writes staged into the chain transaction (ADR-0044).--shared/lib/types.d.ts:246
targetstring---shared/lib/types.d.ts:237
versionstring---shared/lib/types.d.ts:238