Skip to content

Commit

Permalink
(docs): note redux-persist's Storage Engines compatibility
Browse files Browse the repository at this point in the history
- redux-persist's Storage Engines all follow the same localForage-style
  async Promise API, so they should all be compatible with mst-persist
  as well
  - docs should mention this as the interoperability adds many more
    usage options for developers
    - e.g. using node-storage or cookie-storage for Node or universal
      apps, which should now work without bugs
  • Loading branch information
agilgur5 committed Jul 27, 2019
1 parent 6da8094 commit a36a41b
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ persist('some', someStore, {
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.
<br>
Any of [`redux-persist`'s Storage Engines](https://github.com/rt2zz/redux-persist#storage-engines) should also be compatible with `mst-persist`.
- **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 a36a41b

Please sign in to comment.