# SnapshotDiff

Fields, allowed values, and APIs that use SnapshotDiff.

Canonical: https://grid.syidax.com/docs/types/SnapshotDiff/

<a id="definition"></a>

## Type definition

A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.

```typescript
export interface SnapshotDiff<TRow = Record<string, unknown>> {
  readonly added: TRow[];
  readonly removed: TRow[];
  readonly changed: SnapshotRowChange[];
  readonly summary: { added: number; removed: number; changed: number };
}
```

<a id="used-by"></a>

## APIs using this type

- [diffSnapshots](https://grid.syidax.com/docs/methods/diffSnapshots.md) — Compares two snapshots or a snapshot with current data. Omit the second ID to compare against current data.

<a id="parents"></a>

## Contracts containing this type

- [SyGridImperativeMethods](https://grid.syidax.com/docs/types/SyGridImperativeMethods.md)

<a id="related"></a>

## Related types

- [SnapshotRowChange](https://grid.syidax.com/docs/types/SnapshotRowChange.md)