Better documention for immutablejs (#290)

zalmoxisus · Jan 20, 2017 · 6426fc5 · 6426fc5
1 parent 910bb35
commit 6426fc5
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -89,7 +89,7 @@
     typeof window === 'object' &&
     window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ ?   
       window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__({
-        // Specify here name, actionsBlacklist, actionsCreators and other options
+        // Specify extension’s options like here name, actionsBlacklist, actionsCreators or immutablejs support
       }) : compose;
 
   const enhancer = composeEnhancers(

diff --git a/docs/API/Arguments.md b/docs/API/Arguments.md
@@ -32,7 +32,6 @@ Use `window.__REDUX_DEVTOOLS_EXTENSION__([config])` or `window.__REDUX_DEVTOOLS_
        - `false` - handle only circular references.
        - `true` - handle also dates, regexes, undefined, error objects, symbols, and functions.
        - object, which contains `date`, `regex`, `undefined`, `error`, and `function` keys. Fo each of them you can indicate whether to include (if set as `true`). For `function` key you can also specify a custom function which handles serialization. See [`jsan`](https://github.com/kolodny/jsan) for more details. Example:
-
      ```js
      const store = Redux.createStore(reducer, window.__REDUX_DEVTOOLS_EXTENSION__ && window.__REDUX_DEVTOOLS_EXTENSION__({
        serialize: { 
@@ -43,6 +42,18 @@ Use `window.__REDUX_DEVTOOLS_EXTENSION__([config])` or `window.__REDUX_DEVTOOLS_
        }
      }));
      ```
+    - **immutable** `object`: Automatically serialize/deserialize immutablejs via [remotedev-serialize](https://github.com/zalmoxisus/remotedev-serialize)
+    ```js
+        import Immutable from 'immutable'; // https://facebook.github.io/immutable-js/
+        // ...
+        // Like above, only showing off compose this time. Reminder you might not want this in prod.
+        const composeEnhancers = typeof window === 'object' && typeof window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__ !== 'undefined' ?
+                                   window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__({
+                                     serialize: {
+                                       immutable: Immutable
+                                     }
+                                   }) : compose;
+    ```
 
     Example of usage with mori data structures:
       ```js