Add type to stub action creator (#157)

Author: chawes13

docs.md

@@ -359,7 +359,7 @@ handleActions({
 
 // ** Stubbing a failed request: **
 
-export const fetchUser = createStubRequest('FETCH_USER', (id) => { 
+export const fetchUser = createStubRequest('FETCH_USER', (id) => {
    throw new Error('My mock error.')
 })
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@launchpadlab/lp-redux-api",
-  "version": "6.3.0",
+  "version": "6.3.1",
   "description": "redux middleware and api library",
   "main": "lib/index.js",
   "scripts": {

src/create-stub-request.js

@@ -4,10 +4,10 @@ import { isObject, isFunction, identity } from 'lodash'
 
 /**
  * A function that creates action creators for making stubbed API requests.
- * 
+ *
  * Unlike {@link createRequest}, these action creators do not make real API calls but rather
  * resolve immediately with the provided data.
- * 
+ *
  * If an exception is thrown from the data creator function, the "request" will reject with that exception instead of resolving.
  *
  * @name createStubRequest
@@ -19,29 +19,29 @@ import { isObject, isFunction, identity } from 'lodash'
  * @example
  *
  * // ** Stubbing a successful request: **
- * 
+ *
  * export const fetchUser = createStubRequest('FETCH_USER', (id) => ({ id }))
  *
  * fetchUsers(5)
  * // -> won't make any api request, but will resolve with data { id: 5 }
  *
  * // Just like in redux-actions, this action can be referenced in a reducer by name:
- * 
+ *
  * handleActions({
  *    [apiActions.fetchUser]: (state, action) => ...
  * })
- * 
+ *
  * // ** Stubbing a failed request: **
- * 
- * export const fetchUser = createStubRequest('FETCH_USER', (id) => { 
+ *
+ * export const fetchUser = createStubRequest('FETCH_USER', (id) => {
  *    throw new Error('My mock error.')
  * })
  *
  * fetchUsers(5)
  * // -> won't make any api request, but will reject with the given error.
  *
  * // ** Simulating a response delay: **
- * 
+ *
  * export const fetchUser = createStubRequest('FETCH_USER', (id) => {
  *  return {
  *    id
@@ -74,6 +74,7 @@ function createStubRequest (type, definition=identity, { delay }={}) {
     }
   }
   actionCreator.toString = () => LP_API_ACTION_NAMESPACE + type
+  actionCreator.type = LP_API_ACTION_NAMESPACE + type
   return actionCreator
 }
 

test/create-stub-request.test.js

@@ -1,33 +1,34 @@
 import { createStubRequest, LP_API } from '../src'
+import { LP_API_ACTION_NAMESPACE } from '../src/actions'
 import { REQUEST_TYPE } from './fixtures'
 
 describe('createStubRequest', () => {
   test('requires a type argument', () => {
     expect(createStubRequest).toThrow()
   })
-  
+
   test('accepts object data', () => {
     const stubData = { foo: 'bar' }
     const actionCreator = createStubRequest(REQUEST_TYPE, stubData)
     const action = actionCreator()
     expect(action[LP_API]).toEqual({ type: REQUEST_TYPE, isStub: true, stubData })
   })
-  
+
   test('accepts function data creator', () => {
     const actionCreator = createStubRequest(REQUEST_TYPE, (arg) => ({
       foo: arg
     }))
     const action = actionCreator('bar')
     expect(action[LP_API]).toEqual({ type: REQUEST_TYPE, isStub: true, stubData: { foo: 'bar' } })
   })
-  
+
   test('accepts delay option', () => {
     const stubData = { foo: 'bar' }
     const actionCreator = createStubRequest(REQUEST_TYPE, stubData, { delay: 500 })
     const action = actionCreator()
     expect(action[LP_API]).toEqual({ type: REQUEST_TYPE, isStub:true, stubData, delay: 500 })
   })
-  
+
   test('function sets data and error flag from thrown exception', () => {
     const myException = new Error('oops')
     const actionCreator = createStubRequest(REQUEST_TYPE, () => {
@@ -36,14 +37,24 @@ describe('createStubRequest', () => {
     const action = actionCreator('bar')
     expect(action[LP_API]).toEqual({ type: REQUEST_TYPE, isStub: true, isStubError: true, stubData: myException })
   })
-  
+
   test('defaults to identity for data creator', () => {
     const actionCreator = createStubRequest(REQUEST_TYPE)
     const action = actionCreator('bar')
     expect(action[LP_API]).toEqual({ type: REQUEST_TYPE, isStub: true, stubData: 'bar' })
   })
-  
+
   test('rejects other types of data definitions', () => {
     expect(() => createStubRequest(REQUEST_TYPE, 'wtf')).toThrow()
   })
+
+  test('has the namespaced action type as its string representation', () => {
+    const actionCreator = createStubRequest(REQUEST_TYPE)
+    expect(actionCreator.toString()).toEqual(LP_API_ACTION_NAMESPACE+REQUEST_TYPE)
+  })
+
+  test('has the namespaced action type set to the special `type` property', () => {
+    const actionCreator = createStubRequest(REQUEST_TYPE)
+    expect(actionCreator.type).toEqual(LP_API_ACTION_NAMESPACE+REQUEST_TYPE)
+  })
 })