Reason 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.
Type · import type { Reason } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 2. Operations, reports, causes, problems
Why an operation did not commit.
expectRevision did not match, the expectGroup you passed was not open at the
call, an applyPatch 'test' failed, or a queued applyPatch path or select group or
material that resolved at the call no longer resolves at the write's turn (spec section 6.4).expectRevision was given while a transaction was open or queued ahead of the write,
or a recorded write was pending ahead of it in the write queue (pending look-only writes such
as apply, and dry runs, open or queued, don't count).timeoutMs passed without progress, or the hold cap was reached.tx failed and work never observed it.session or a tx,
failed inside the runtime before its commit point; that write, or the transaction holding it,
rolled back and lists 'sync-failed' in problems (spec section 6.4).owner, or
through a part that reads exists: false (never a node() handle); nothing ran, matched
is 0 without 'target-unmatched', and problems holds 'handle-disposed' (spec section 3.4).| Code | Summary |
|---|---|
'conflict' |
expectRevision did not match, the expectGroup you passed was not open at the call, an applyPatch 'test' failed, or a queued applyPatch path or select group or material that resolved at the call no longer resolves at the write's turn (spec section 6.4). |
'busy' |
expectRevision was given while a transaction was open or queued ahead of the write, or a recorded write was pending ahead of it in the write queue (pending look-only writes such as apply, and dry runs, open or queued, don't count). |
'timeout' |
timeoutMs passed without progress, or the hold cap was reached. |
'enlisted-failed' |
an operation started through the tx failed and work never observed it. |
'empty' |
undo or redo had nothing to do. |
'no-candidate' |
an attach that changed nothing (spec section 6.12, rule A2). |
'occupied' |
an attach that changed nothing (spec section 6.12, rule A2). |
'rejected' |
an attach that changed nothing (spec section 6.12, rule A2). |
'not-loaded' |
an attach that changed nothing (spec section 6.12, rule A2). |
'internal-error' |
applying a state write, recorded or look-only, through session or a tx, failed inside the runtime before its commit point; that write, or the transaction holding it, rolled back and lists 'sync-failed' in problems (spec section 6.4). |
'disposed' |
a new write through a disposed collection or naming one as its owner, or through a part that reads exists: false (never a node() handle); nothing ran, matched is 0 without 'target-unmatched', and problems holds 'handle-disposed' (spec section 3.4). |
The set is open: a code newer than your declared contract arrives as 'other'.
export type Reason = 'conflict' | 'busy' | 'timeout' | 'enlisted-failed' | 'empty' | 'no-candidate' | 'occupied' | 'rejected' | 'not-loaded' | 'internal-error' | 'disposed' | 'other';| Rule | Result |
|---|---|
| 1. Neutral name | pass: Reason names no product |
| 2. A precedent | not recorded: no ledger row (coverage.json) names this member or its owner |
| 3. Two apps, or labs | not recorded: no ledger row names this member or its owner |
| 4. The cheaper fix first | not recorded per member (Appendix B decides it per need) |