Skip to content

Commit

Permalink
feat: update comment
Browse files Browse the repository at this point in the history
  • Loading branch information
ouduidui committed Apr 27, 2022
1 parent e6b5528 commit 8d477e4
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/types.ts
Expand Up @@ -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
}

0 comments on commit 8d477e4

Please sign in to comment.