ReportFields ​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 { ReportFields } from '@holostep-configurators/runtime-client/contract'; · stable · since 2.0.0 · section 2. Operations, reports, causes, problems
The fields every Report has. Frozen.
| Member | Kind | Summary |
|---|---|---|
op |
property | The operation's id, assigned at the call. |
origin |
property | Your origin tag, echoed unchanged; null when you gave none. |
seq |
property | The commit that carried this operation (session.seq at its commit point); null unless it committed and changed something. |
revision |
property | session.revision when the operation settled. |
changed |
property | True when this operation's commit changed state ('dry-run': would have changed it). |
matched |
property | Parts or nodes the write matched. |
pending |
property | True while a matched model, or a queued scene write the query may match, still loads; the write applies once it lands. |
completed |
property | False when readiness expired (readyTimeoutMs): stand-ins or old looks may still show. |
problems |
property | Asset failures and other non-fatal problems of this operation. |
export interface ReportFields {
readonly op: OpId;
readonly origin: string | null;
readonly seq: number | null;
readonly revision: number;
readonly changed: boolean;
readonly matched: number;
readonly pending: boolean;
readonly completed: boolean;
readonly problems: readonly Problem[];
}
| Rule | Result |
|---|---|
| 1. Neutral name | pass: ReportFields 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) |