Interface: WorkspacePersistenceProvider

Defined in: application/services/persistence/workspace-persistence-service.ts:24

A storage backend that can save and load workspace snapshots. Implementations must provide every method except deleteSnapshot.

Properties

connect

connect: (options?) => Promise<unknown>;

Defined in: application/services/persistence/workspace-persistence-service.ts:32

Connects or authenticates. The meaning of options is provider specific.

Parameters

Parameter	Type
options?	Record<string, unknown>

Returns

Promise<unknown>

---

deleteSnapshot?

deleteSnapshot?: (snapshotId) => Promise<void>;

Defined in: application/services/persistence/workspace-persistence-service.ts:41

Optional. Deletes a snapshot by id.

Parameters

Parameter	Type
snapshotId	string

Returns

Promise<void>

---

disconnect

disconnect: () => void;

Defined in: application/services/persistence/workspace-persistence-service.ts:33

Returns

void

---

getCapabilities

getCapabilities: () => WorkspacePersistenceProviderCapabilities;

Defined in: application/services/persistence/workspace-persistence-service.ts:29

Returns

WorkspacePersistenceProviderCapabilities

---

getConnectionState

getConnectionState: () => WorkspacePersistenceConnectionState;

Defined in: application/services/persistence/workspace-persistence-service.ts:30

Returns

WorkspacePersistenceConnectionState

---

id

id: string;

Defined in: application/services/persistence/workspace-persistence-service.ts:26

Unique provider id used to register and select the provider.

---

label?

label?: string;

Defined in: application/services/persistence/workspace-persistence-service.ts:28

Display label. Falls back to id when omitted.

---

listSnapshots

listSnapshots: () => Promise<object[]>;

Defined in: application/services/persistence/workspace-persistence-service.ts:36

Returns

Promise<object[]>

---

loadSnapshot

loadSnapshot: (snapshotId?) => Promise<unknown>;

Defined in: application/services/persistence/workspace-persistence-service.ts:39

Loads a snapshot by id. When no id is given, providers typically load their default or latest snapshot.

Parameters

Parameter	Type
snapshotId?	string | null

Returns

Promise<unknown>

---

saveSnapshot

saveSnapshot: (payload) => Promise<unknown>;

Defined in: application/services/persistence/workspace-persistence-service.ts:37

Parameters

Parameter	Type
payload	unknown

Returns

Promise<unknown>

---

tryRestoreConnection

tryRestoreConnection: () => Promise<boolean>;

Defined in: application/services/persistence/workspace-persistence-service.ts:35

Attempts to reuse a stored session without user interaction. Resolves to true on success.

Returns

Promise<boolean>