Skip to content

Vizel API / react/src / UseVizelAutoSaveResult

Interface: UseVizelAutoSaveResult ​

Defined in: packages/react/src/hooks/useVizelAutoSave.ts:15

Auto-save hook result

Properties ​

error ​

ts
error: Error | null;

Defined in: packages/react/src/hooks/useVizelAutoSave.ts:23

Last error that occurred


hasUnsavedChanges ​

ts
hasUnsavedChanges: boolean;

Defined in: packages/react/src/hooks/useVizelAutoSave.ts:19

Whether there are unsaved changes


lastSaved ​

ts
lastSaved: Date | null;

Defined in: packages/react/src/hooks/useVizelAutoSave.ts:21

Timestamp of last successful save


restore ​

ts
restore: () => Promise<JSONContent | null>;

Defined in: packages/react/src/hooks/useVizelAutoSave.ts:27

Restore content from storage

Returns ​

Promise&lt;JSONContent | null&gt;


save ​

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

Defined in: packages/react/src/hooks/useVizelAutoSave.ts:25

Manually trigger save

Returns ​

Promise&lt;void&gt;


status ​

ts
status: VizelSaveStatus;

Defined in: packages/react/src/hooks/useVizelAutoSave.ts:17

Current save status

Released under the MIT License.