(docs): clearup docs around inbound/outbound state on transforms

rt2zz · Sep 1, 2017 · 867317c · 867317c
1 parent b1c2e33
commit 867317c
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -115,9 +115,9 @@ import { createTransform, persistReducer } from 'redux-persist'
 
 let myTransform = createTransform(
   // transform state coming from redux on its way to being serialized and stored
-  (inboundState, key) => specialSerialize(inboundState, key),
+  (state, key) => specialSerialize(state, key),
   // transform state coming from storage, on its way to be rehydrated into redux
-  (outboundState, key) => specialDeserialize(outboundState, key),
+  (state, key) => specialDeserialize(state, key),
   // configuration options
   {whitelist: ['specialKey']}
 )

diff --git a/src/createTransform.js b/src/createTransform.js
@@ -6,7 +6,9 @@ type TransformConfig = {
 }
 
 export default function createTransform(
+  // @NOTE inbound: transform state coming from redux on its way to being serialized and stored
   inbound: Function,
+  // @NOTE outbound: transform state coming from storage, on its way to be rehydrated into redux
   outbound: Function,
   config: TransformConfig = {}
 ) {