From 8d477e4a64920796d60045a2d621cfe018dacd50 Mon Sep 17 00:00:00 2001 From: Dewey Ou Date: Wed, 27 Apr 2022 17:31:16 +0800 Subject: [PATCH] feat: update comment --- src/types.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/types.ts b/src/types.ts index 431ab8e..7fc91dd 100644 --- a/src/types.ts +++ b/src/types.ts @@ -29,14 +29,17 @@ export interface Storage { export interface PersistOptions { /** * it is the prefix of the key to store the persisted state under, such as the store id is "test", that store key is "pinia_test" by default. + * @default pinia */ prefix?: string /** * it is the storage for state persist, you can choose localStorage, sessionStorage or your custom storage. + * @default window.localStorage */ storage?: Storage /** * when app first loader or refresh, whether to overwrite the existing state with the output from state directly, instead of merging the two objects with deep merge. + * @default false */ overwrite?: boolean }