Skip to content

@statesync/persistence


@statesync/persistence / PersistedSnapshot

Interface: PersistedSnapshot<T> ​

Defined in: persistence/src/types.ts:140

A persisted snapshot bundled with its associated metadata.

This is the unit of storage for backends that support metadata (StorageBackendWithMetadata). It pairs the actual state envelope with bookkeeping information (timestamps, schema version, compression flag, etc.).

Type Parameters ​

Type ParameterDescription
TThe shape of the application state.

Properties ​

metadata ​

ts
metadata: PersistedSnapshotMetadata;

Defined in: persistence/src/types.ts:145

Metadata describing when and how the snapshot was persisted.


snapshot ​

ts
snapshot: SnapshotEnvelope<T>;

Defined in: persistence/src/types.ts:142

The snapshot envelope containing the revision and state data.

Released under the MIT License.