Events.committed ​

Contract 2.0.0 · package sha256 a857eca95b35921109faf997094bb4192f12527d9d0fcd4be7e97f06425bad6e · generated from configurator-runtime.d.ts by services/onsite-scripter/scripts/build-contract-docs.mjs; edit the source, not this file.

Property of Events · stable · since 2.0.0

'committed': {
  readonly cause: Cause;
  readonly label: string | null;
  readonly recorded: boolean;
  readonly patch: readonly JsonPatchOp[];
  readonly inverse: readonly JsonPatchOp[];
  readonly checkpoint: JsonValue | null;
};

The commit feed: one entry per commit, after it is shown. Skip your own writes by cause.origin.

Fields ​

cause ​

readonly cause: Cause;

Who and what made the commit.

label ​

readonly label: string | null;

The label of the undo step this commit made or joined (a write in a history group joins the group's step and carries its label, O14), or null when the commit is part of no undo step.

recorded ​

readonly recorded: boolean;

True when recorded state changed (revision moved).

patch ​

readonly patch: readonly JsonPatchOp[];

RFC 6902 over SessionState, nodes addressed by nodeId.

inverse ​

readonly inverse: readonly JsonPatchOp[];

The patch that undoes patch, keyed the same way.

checkpoint ​

readonly checkpoint: JsonValue | null;

The page state stored with the commit, or null; for an undo or redo, the restored page state (what state().checkpoint is right after that commit).

Generic-API test (spec 3.1) ​