History ​Contract 2.0.0 · package sha256
a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e· generated fromconfigurator-runtime.d.tsbyservices/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.
Interface · import type { History } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 5. Writers, transactions, session
Undo state and grouping. The flags are intent reads of committed history. Not here: undo()
and redo() are session members (session.undo(), session.redo()), which these flags
describe.
| Member | Kind | Summary |
|---|---|---|
canUndo |
property | Committed history only: a pending or queued write doesn't count yet. |
canRedo |
property | True after an undo, until a new undo step or a rebase clears redo. |
undoLabel |
property | The label of the step undo() would undo, or null. |
redoLabel |
property | The label of the step redo() would redo, or null. |
depth |
property | The number of undo steps above the floor. |
group |
method | Opens a group (immediate): every write called until commit() that makes an undo step (a recorded change, or a labelled look write) is part of one undo step, also one that commits after it (a gesture's last write… |
export interface History {
readonly canUndo: boolean;
readonly canRedo: boolean;
readonly undoLabel: string | null;
readonly redoLabel: string | null;
readonly depth: number;
group(options?: HistoryGroupOptions): HistoryGroup;
}
| Rule | Result |
|---|---|
| 1. Neutral name | pass: History names no product |
| 2. A precedent | not recorded: no ledger row (coverage.json) names this member or its owner |
| 3. Two apps, or labs | pass: 22 apps (fleet cross-check: app-04c2774145, app-37356bf09f, app-4762caacdc, app-4f16d2f6da, app-510d750508, app-59c5b5751e, app-b362a81c85, app-b4ae2fce25 and 14 more) |
| 4. The cheaper fix first | not recorded per member (Appendix B decides it per need) |