SideDoc

Appearance

Interface: PersistenceUiControllerConfig ​

Defined in: application/services/persistence/persistence-ui-controller.ts:62

Configuration for PersistenceUiController.

Properties ​

beforeWorkspaceHydrate? ​

ts
beforeWorkspaceHydrate?: () => void;

Defined in: application/services/persistence/persistence-ui-controller.ts:72

Optional hook. Despite the name, it runs after hydrateWorkspaceSnapshot and before loadPersistedData.

Returns ​

void

defaultProviderId? ​

ts
defaultProviderId?: string;

Defined in: application/services/persistence/persistence-ui-controller.ts:74

Provider to select initially. Defaults to google-drive.

env ​

ts
env: Record<string, unknown>;

Defined in: application/services/persistence/persistence-ui-controller.ts:64

Environment variables used to configure the built-in providers, see the create*PersistenceServiceFromEnv factories.

getWorkspaceSnapshot ​

ts
getWorkspaceSnapshot: () => unknown;

Defined in: application/services/persistence/persistence-ui-controller.ts:70

Returns the current workspace to save, or null when none is loaded.

Returns ​

unknown

hydrateWorkspaceSnapshot ​

ts
hydrateWorkspaceSnapshot: (snapshot) => Promise<void>;

Defined in: application/services/persistence/persistence-ui-controller.ts:66

Replaces the current workspace with a loaded snapshot.

Parameters ​

ParameterType
snapshotunknown

Returns ​

Promise<void>

loadPersistedData ​

ts
loadPersistedData: () => Promise<void>;

Defined in: application/services/persistence/persistence-ui-controller.ts:68

Reloads application data after a snapshot has been hydrated.

Returns ​

Promise<void>