Merge pull request #3877 from reduxjs/tostring-restore

reduxjs · Nov 15, 2023 · 815a705 · 815a705
2 parents 0dc7fdd + 16f5d62
commit 815a705
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 3 deletions.
diff --git a/docs/usage/usage-guide.md b/docs/usage/usage-guide.md
@@ -300,7 +300,7 @@ const reducer = createReducer({}, (builder) => {
 
 This means you don't have to write or use a separate action type variable, or repeat the name and value of an action type like `const SOME_ACTION_TYPE = "SOME_ACTION_TYPE"`.
 
-If you want to use one of these action creators in a switch statement, you need to call `actionCreator.type` yourself:
+If you want to use one of these action creators in a switch statement, you need to reference `actionCreator.type` yourself:
 
 ```js
 const actionCreator = createAction('SOME_ACTION_TYPE')

diff --git a/packages/toolkit/src/createAction.ts b/packages/toolkit/src/createAction.ts
@@ -224,7 +224,8 @@ export type PayloadActionCreator<
 /**
  * A utility function to create an action creator for the given action type
  * string. The action creator accepts a single argument, which will be included
- * in the action object as a field called payload.
+ * in the action object as a field called payload. The action creator function
+ * will also have its toString() overridden so that it returns the action type.
  *
  * @param type The action type to use for created actions.
  * @param prepare (optional) a method that takes any number of arguments and returns { payload } or { payload, meta }.
@@ -239,7 +240,8 @@ export function createAction<P = void, T extends string = string>(
 /**
  * A utility function to create an action creator for the given action type
  * string. The action creator accepts a single argument, which will be included
- * in the action object as a field called payload.
+ * in the action object as a field called payload. The action creator function
+ * will also have its toString() overridden so that it returns the action type.
  *
  * @param type The action type to use for created actions.
  * @param prepare (optional) a method that takes any number of arguments and returns { payload } or { payload, meta }.
@@ -273,6 +275,8 @@ export function createAction(type: string, prepareAction?: Function): any {
     return { type, payload: args[0] }
   }
 
+  actionCreator.toString = () => `${type}`
+
   actionCreator.type = type
 
   actionCreator.match = (action: Action<string>): action is PayloadAction =>

diff --git a/packages/toolkit/src/tests/createAction.test.ts b/packages/toolkit/src/tests/createAction.test.ts
@@ -9,6 +9,13 @@ describe('createAction', () => {
     })
   })
 
+  describe('when stringifying action', () => {
+    it('should return the action type', () => {
+      const actionCreator = createAction('A_TYPE')
+      expect(`${actionCreator}`).toEqual('A_TYPE')
+    })
+  })
+
   describe('when passing a prepareAction method only returning a payload', () => {
     it('should use the payload returned from the prepareAction method', () => {
       const actionCreator = createAction('A_TYPE', (a: number) => ({