# `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`](Events.md) · stable · since 2.0.0

```ts
'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

<a id="cause"></a>
### `cause`

```ts
readonly cause: Cause;
```

Who and what made the commit.

<a id="label"></a>
### `label`

```ts
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.

<a id="recorded"></a>
### `recorded`

```ts
readonly recorded: boolean;
```

True when recorded state changed (revision moved).

<a id="patch"></a>
### `patch`

```ts
readonly patch: readonly JsonPatchOp[];
```

RFC 6902 over [`SessionState`](SessionState.md), nodes addressed by `nodeId`.

<a id="inverse"></a>
### `inverse`

```ts
readonly inverse: readonly JsonPatchOp[];
```

The patch that undoes `patch`, keyed the same way.

<a id="checkpoint"></a>
### `checkpoint`

```ts
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`](SessionState.checkpoint.md) is right after that commit).

## Generic-API test (spec 3.1)

| Rule | Result |
| --- | --- |
| 1. Neutral name | pass: `committed` names no product |
| 2. A precedent | pass: a correctness rule (rows `X2`) |
| 3. Two apps, or labs | pass: 21 apps (ledger: app-4fd23bc869, app-822bb9d6aa, app-8675b3225c, app-b362a81c85, app-bcb7ef21da, app-c1384707fc, app-e3b47169bc, app-e61a0b42ad and 8 more; fleet cross-check: app-04c2774145, app-0c773a4ee3, app-37356bf09f, app-378d190f1b, app-4762caacdc, app-4fd23bc869, app-822bb9d6aa, app-8675b3225c and 13 more) |
| 4. The cheaper fix first | decided per need in Appendix B: rows `X2` at tier stable (a member only where no rule, data, asset or app code serves the need) |