feat(keyedCollection.js): add clear action

README.md

@@ -82,3 +82,5 @@ store.dispatch(userActions.batch([
 ]))
 ```
 
+There is a `clear` action as well that will clear the collection.
+

src/keyedCollection.js

@@ -2,13 +2,19 @@ import {fromJS, Map} from 'immutable'
 import defaults from 'lodash.defaults'
 import createReducer from './createReducer'
 
+export const CLEAR = 'CLEAR'
 export const INSERT = 'INSERT'
 export const UPDATE = 'UPDATE'
 export const REMOVE = 'REMOVE'
 export const BATCH = 'BATCH'
 
 export function actions(actionTypePrefix = '') {
   return {
+    clear() {
+      return {
+        type: actionTypePrefix + CLEAR,
+      }
+    },
     insert(key, fields) {
       return {
         type: actionTypePrefix + INSERT,
@@ -41,9 +47,9 @@ export function actions(actionTypePrefix = '') {
 
 // this looks confusing...it just maintains backwards compatibility with old actions export
 // by assigning unprefixed actions to the actions function
-const {insert, update, remove, batch} = actions()
-export {insert, update, remove, batch}
-Object.assign(actions, {insert, update, remove, batch})
+const {clear, insert, update, remove, batch} = actions()
+export {clear, insert, update, remove, batch}
+Object.assign(actions, {clear, insert, update, remove, batch})
 
 const defaultOptions = {
   actionTypePrefix: '',
@@ -60,6 +66,7 @@ const defaultOptions = {
 export function reducer(options) {
   const {createReducer, createDocument, merge, initialState, enhance, actionTypePrefix} = defaults({}, options, defaultOptions)
   let reducer = createReducer(initialState, {
+    [actionTypePrefix + CLEAR]: collection => collection.clear(),
     [actionTypePrefix + INSERT]: (collection, {payload, meta: {key}}) => collection.update(key, doc => doc || createDocument(payload)),
     [actionTypePrefix + UPDATE]: (collection, {payload, meta: {key}}) => collection.update(key, doc => merge(doc, payload)),
     [actionTypePrefix + REMOVE]: (collection, {meta: {key}}) => collection.delete(key),

test/keyedCollectionTest.js

@@ -8,7 +8,12 @@ chai.use(chaiImmutable)
 
 describe('keyedCollectionReducer', () => {
   function tests(actions, reducer) {
-    const {insert, update, remove, batch} = actions
+    const {clear, insert, update, remove, batch} = actions
+    describe('clear', () => {
+      it('clears collection', () => {
+        expect(reducer(Map({hello: 'world'}), clear())).to.equal(fromJS({}))
+      })
+    })
     describe('insert', () => {
       it('inserts if no document exists', () => {
         expect(reducer(undefined, insert('a', {hello: 'world'}))).to.equal(fromJS({a: {hello: 'world'}}))