Skip to content

Commit

Permalink
(docs): re-word storage section for clarity
Browse files Browse the repository at this point in the history
  • Loading branch information
agilgur5 committed Jul 27, 2019
1 parent a2f22a6 commit 6da8094
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,10 @@ persist('some', someStore, {
- **key** *string* The key of your storage engine that you want to persist to.
- **store** *MST store* The store to be persisted.
- **options** *object* Additional configuration options.
- **storage** *[localForage](https://github.com/localForage/localForage) / AsyncStorage / localStorage* [localForage](https://github.com/localForage/localForage)-style storage API. localStorage for Web (default), AsyncStorage for React Native.
- **storage** *[localForage](https://github.com/localForage/localForage) / AsyncStorage / localStorage*
Any Storage Engine that has a Promise-style API similar to [`localForage`](https://github.com/localForage/localForage).
The default is `localStorage`, which has a built-in adaptor to make it support Promises.
For React Native, one may configure `AsyncStorage` instead.
- **jsonify** *bool* Enables serialization as JSON (default: `true`).
- **whitelist** *Array\<string\>* Only these keys will be persisted (defaults to all keys).
- **blacklist** *Array\<string\>* These keys will not be persisted (defaults to all keys).
Expand Down

0 comments on commit 6da8094

Please sign in to comment.