Skip to content

Commit 88950d4

Browse files
committed
docs: update README.md
1 parent e2de136 commit 88950d4

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,43 @@
3131

3232
## 用法
3333

34-
**vuex-refesh-storage**
34+
**vuex-refesh-storage (for Vuex# and Vue2)**
3535

36+
**use JavaScript**
3637

38+
```js
39+
import Vuex from "vuex";
40+
import VuexRefeshStorage from 'vue-refesh-storage';
41+
const vuexRefeshStorage = new VuexRefeshStorage()
42+
// vue 2
43+
const store = new Vuex.Store({
44+
plugins: [vuexRefeshStorage.install]
45+
})
46+
```
47+
48+
**use TypeScript**
49+
50+
```js
51+
import Vuex from "vuex";
52+
import VuexRefeshStorage from 'vue-refesh-storage';
53+
const vuexRefeshStorage = new VuexPersistence<RootState>({
54+
storage: window.localStorage
55+
})
56+
// vue 2
57+
const store = new Vuex.Store<State>({
58+
plugins: [vuexRefeshStorage.install]
59+
})
60+
```
61+
62+
## API
63+
64+
初始化参数`new VuexRefeshStorage([options])`
65+
66+
通过`new`实例化一个`VuexRefeshStorage`可以传入一下`options`定制一些功能。
67+
68+
| Property | Type | Descript |
69+
| -------- | ---- | ---------------------------- |
70+
| key | string | 存储持久状态的密钥。默认为vuex。 |
71+
| modules | string[] | 您要保留的模块列表。(如果要使用此功能,请不要编写自己的reducer) |
72+
| storage | Storage(web API) | localStorage, sessionStorage, localforage 或者 自定义 Storage object. <br>一定要包含 setItem、getItem、clear <br> _**Default: window.localStorage**_ |
73+
| setState | function<br> (key, state[, storage]) | 存储持久状态的密钥。默认为vuex。 |

0 commit comments

Comments
 (0)