Skip to content

Vizel API / core/src / VizelAutoSaveOptions

Interface: VizelAutoSaveOptions ​

Defined in: packages/core/src/auto-save.ts:16

Auto-save configuration options

Properties ​

debounceMs? ​

ts
optional debounceMs?: number;

Defined in: packages/core/src/auto-save.ts:20

Debounce delay in milliseconds (default: 1000)


enabled? ​

ts
optional enabled?: boolean;

Defined in: packages/core/src/auto-save.ts:18

Enable auto-save (default: true)


key? ​

ts
optional key?: string;

Defined in: packages/core/src/auto-save.ts:24

Storage key for localStorage/sessionStorage (default: 'vizel-content')


onError? ​

ts
optional onError?: (error) => void;

Defined in: packages/core/src/auto-save.ts:31

Callback when save or restore fails. The error may be a VizelError — narrow with isVizelError(error) to access the structured code field.

Parameters ​

ParameterType
errorError

Returns ​

void


onRestore? ​

ts
optional onRestore?: (content) => void;

Defined in: packages/core/src/auto-save.ts:33

Callback when restore is attempted

Parameters ​

ParameterType
contentJSONContent | null

Returns ​

void


onSave? ​

ts
optional onSave?: (content) => void;

Defined in: packages/core/src/auto-save.ts:26

Callback when content is saved

Parameters ​

ParameterType
contentJSONContent

Returns ​

void


storage? ​

ts
optional storage?: VizelStorageBackend;

Defined in: packages/core/src/auto-save.ts:22

Storage backend (default: 'localStorage')

Released under the MIT License.