Add flush to docs

convoyinc · Apr 4, 2017 · 2b5229c · 2b5229c
1 parent bae8d84
commit 2b5229c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -75,6 +75,8 @@ persistStore(store, config, callback).purge()
       - pauses persistence
     - `resume()`
       - resumes persistence
+    - `flush()`
+      - Writes the current state of the store out to storage.
 
 #### `autoRehydrate(config)`
   - This is a store enhancer that will automatically shallow merge the persisted state for each key. Additionally it queues any actions that are dispatched before rehydration is complete, and fires them after rehydration is finished.

diff --git a/docs/api.md b/docs/api.md
@@ -7,7 +7,7 @@
 - [getStoredState(config, callback)](#getstoredstateconfig-callback) -> Promise -> State
 - [createPersistor(store, config)](#createpersistorstore-config) -> Persistor
 - [createTransform(in, out, config)](#createtransformin-out-config) -> Transform
-- [purgeStoredState(config, keys)](#purgestoredstateconfig-keys) -> Promise -> void  
+- [purgeStoredState(config, keys)](#purgestoredstateconfig-keys) -> Promise -> void
 
 **objects**
 - [config](#config-)
@@ -83,6 +83,7 @@ persistor.rehydrate(incomingState, {serial: true})
 persistor.purge()
 persistor.pause()
 persistor.resume()
+persistor.flush()
 ```
 
 #### transform {}