create addMeta

Author: jedwards1211

README.md

@@ -110,3 +110,25 @@ const setConfigEntry = prefixActionCreator('CONFIG.')(setEntry)
 
 setConfigEntry('hello', 'world').type // CONFIG.SET_ENTRY
 
+## addMeta(meta: Object): (actionCreator: ActionCreator) => ActionCreator
+```js
+import {addMeta} from 'mindfront-redux-utils';
+```
+
+An action creator decorator that assigns additional properties to created actions' `meta`.
+
+### Example
+import {addMeta} from 'mindfront-redux-utils'
+
+function setEntry(key, value) {
+  return {
+    type: 'SET_ENTRY',
+    payload: value,
+    meta: {key}
+  }
+}
+
+const setConfigEntry = addMeta({domain: 'config'})(setEntry)
+
+setConfigEntry('hello', 'world').meta // {key: 'hello', domain: 'config'}
+

src/addMeta.js

@@ -0,0 +1,13 @@
+export default function addMeta(meta) {
+  return actionCreator => (...args) => {
+    const action = actionCreator(...args)
+    return {
+      ...action,
+      meta: {
+        ...action.meta,
+        ...meta
+      }
+    }
+  }
+}
+

src/index.js

@@ -7,6 +7,7 @@ import composeMiddleware from './composeMiddleware'
 import createPluggableMiddleware from './createPluggableMiddleware'
 import prefixReducer from './prefixReducer'
 import prefixActionCreator from './prefixActionCreator'
+import addMeta from './addMeta'
 
 export {
   createReducer,
@@ -16,5 +17,6 @@ export {
   createPluggableMiddleware,
   prefixReducer,
   prefixActionCreator,
+  addMeta,
 }
 

test/addMetaTest.js

@@ -0,0 +1,44 @@
+import {expect} from 'chai'
+import addMeta from '../src/addMeta'
+
+describe('addMeta', () => {
+  it('adds meta to created actions', () => {
+    function setEntry(key, value) {
+      return {
+        type: 'SET_ENTRY',
+        payload: value,
+        meta: {key}
+      }
+    }
+
+    const setEntry2 = addMeta({domain: 'config'})(setEntry)
+    expect(setEntry2('hello', 'world')).to.deep.equal({
+      type: 'SET_ENTRY',
+      payload: 'world',
+      meta: {key: 'hello', domain: 'config'},
+    })
+
+    const setEntry3 = addMeta({key: 'blah', domain: 'config'})(setEntry)
+    expect(setEntry3('hello', 'world')).to.deep.equal({
+      type: 'SET_ENTRY',
+      payload: 'world',
+      meta: {key: 'blah', domain: 'config'},
+    })
+  })
+  it('works if the original action has no meta', () => {
+    function setValue(value) {
+      return {
+        type: 'SET_VALUE',
+        payload: value,
+      }
+    }
+
+    const setValue2 = addMeta({domain: 'config'})(setValue)
+    expect(setValue2('hello')).to.deep.equal({
+      type: 'SET_VALUE',
+      payload: 'hello',
+      meta: {domain: 'config'},
+    })
+  })
+})
+