Rename API to createListenerMiddleware

Author: markerikson

packages/action-listener-middleware/src/index.ts

@@ -271,7 +271,7 @@ const defaultErrorHandler: ListenerErrorHandler = (...args: unknown[]) => {
 /**
  * @alpha
  */
-export function createActionListenerMiddleware<
+export function createListenerMiddleware<
   S = unknown,
   D extends Dispatch<AnyAction> = ThunkDispatch<S, unknown, AnyAction>,
   ExtraArgument = unknown

packages/action-listener-middleware/src/tests/effectScenarios.test.ts

@@ -7,7 +7,7 @@ import {
 
 import type { AnyAction, PayloadAction, Action } from '@reduxjs/toolkit'
 
-import { createActionListenerMiddleware, TaskAbortError } from '../index'
+import { createListenerMiddleware, TaskAbortError } from '../index'
 
 import type { TypedAddListener } from '../index'
 
@@ -35,13 +35,13 @@ describe('Saga-style Effects Scenarios', () => {
   const { increment, decrement, incrementByAmount } = counterSlice.actions
 
   let { reducer } = counterSlice
-  let middleware: ReturnType<typeof createActionListenerMiddleware>
+  let middleware: ReturnType<typeof createListenerMiddleware>
 
   let store = configureStore({
     reducer,
-    middleware: (gDM) => gDM().prepend(createActionListenerMiddleware()),
+    middleware: (gDM) => gDM().prepend(createListenerMiddleware()),
   })
-  // let middleware: ActionListenerMiddleware<CounterState> //: ReturnType<typeof createActionListenerMiddleware>
+  // let middleware: ActionListenerMiddleware<CounterState> //: ReturnType<typeof createListenerMiddleware>
 
   const testAction1 = createAction<string>('testAction1')
   type TestAction1 = ReturnType<typeof testAction1>
@@ -64,7 +64,7 @@ describe('Saga-style Effects Scenarios', () => {
   })
 
   beforeEach(() => {
-    middleware = createActionListenerMiddleware()
+    middleware = createListenerMiddleware()
     addListener = middleware.addListener as TypedAddListener<RootState>
     store = configureStore({
       reducer,

packages/action-listener-middleware/src/tests/fork.test.ts

@@ -3,7 +3,7 @@ import { configureStore, createSlice } from '@reduxjs/toolkit'
 
 import type { PayloadAction } from '@reduxjs/toolkit'
 import type { ForkedTaskExecutor, TaskResult } from '../types'
-import { createActionListenerMiddleware, TaskAbortError } from '../index'
+import { createListenerMiddleware, TaskAbortError } from '../index'
 
 function delay(ms: number) {
   return new Promise((resolve) => setTimeout(resolve, ms))
@@ -52,14 +52,14 @@ describe('fork', () => {
     },
   })
   const { increment, decrement, incrementByAmount } = counterSlice.actions
-  let middleware = createActionListenerMiddleware()
+  let middleware = createListenerMiddleware()
   let store = configureStore({
     reducer: counterSlice.reducer,
     middleware: (gDM) => gDM().prepend(middleware),
   })
 
   beforeEach(() => {
-    middleware = createActionListenerMiddleware()
+    middleware = createListenerMiddleware()
     store = configureStore({
       reducer: counterSlice.reducer,
       middleware: (gDM) => gDM().prepend(middleware),

packages/action-listener-middleware/src/tests/listenerMiddleware.test.ts

@@ -9,7 +9,7 @@ import {
 import type { AnyAction, PayloadAction, Action } from '@reduxjs/toolkit'
 
 import {
-  createActionListenerMiddleware,
+  createListenerMiddleware,
   createListenerEntry,
   addListenerAction,
   removeListenerAction,
@@ -108,10 +108,10 @@ export function expectNotAny<T extends IsNotAny<T>>(t: T): T {
   return t
 }
 
-describe('createActionListenerMiddleware', () => {
+describe('createListenerMiddleware', () => {
   let store = configureStore({
     reducer: () => 42,
-    middleware: (gDM) => gDM().prepend(createActionListenerMiddleware()),
+    middleware: (gDM) => gDM().prepend(createListenerMiddleware()),
   })
 
   interface CounterState {
@@ -141,12 +141,12 @@ describe('createActionListenerMiddleware', () => {
   }
 
   let reducer: jest.Mock
-  let middleware: ReturnType<typeof createActionListenerMiddleware>
+  let middleware: ReturnType<typeof createListenerMiddleware>
   let addTypedListenerAction =
     addListenerAction as TypedAddListenerAction<CounterState>
   let removeTypedListenerAction =
     removeListenerAction as TypedRemoveListenerAction<CounterState>
-  // let middleware: ActionListenerMiddleware<CounterState> //: ReturnType<typeof createActionListenerMiddleware>
+  // let middleware: ActionListenerMiddleware<CounterState> //: ReturnType<typeof createListenerMiddleware>
 
   const testAction1 = createAction<string>('testAction1')
   type TestAction1 = ReturnType<typeof testAction1>
@@ -160,7 +160,7 @@ describe('createActionListenerMiddleware', () => {
   })
 
   beforeEach(() => {
-    middleware = createActionListenerMiddleware()
+    middleware = createListenerMiddleware()
     reducer = jest.fn(() => ({}))
     store = configureStore({
       reducer,
@@ -171,7 +171,7 @@ describe('createActionListenerMiddleware', () => {
   describe('Middleware setup', () => {
     test('Allows passing an extra argument on middleware creation', () => {
       const originalExtra = 42
-      const middleware = createActionListenerMiddleware({
+      const middleware = createListenerMiddleware({
         extra: originalExtra,
       })
       const store = configureStore({
@@ -744,7 +744,7 @@ describe('createActionListenerMiddleware', () => {
     test('getOriginalState can only be invoked synchronously', async () => {
       const onError = jest.fn()
 
-      middleware = createActionListenerMiddleware({ onError })
+      middleware = createListenerMiddleware({ onError })
       const store = configureStore({
         reducer: counterSlice.reducer,
         middleware: (gDM) => gDM().prepend(middleware),
@@ -890,7 +890,7 @@ describe('createActionListenerMiddleware', () => {
 
     test('Notifies sync listener errors to `onError`, if provided', async () => {
       const onError = jest.fn()
-      middleware = createActionListenerMiddleware({
+      middleware = createListenerMiddleware({
         onError,
       })
       reducer = jest.fn(() => ({}))
@@ -920,7 +920,7 @@ describe('createActionListenerMiddleware', () => {
 
     test('Notifies async listeners errors to `onError`, if provided', async () => {
       const onError = jest.fn()
-      middleware = createActionListenerMiddleware({
+      middleware = createListenerMiddleware({
         onError,
       })
       reducer = jest.fn(() => ({}))
@@ -1175,7 +1175,7 @@ describe('createActionListenerMiddleware', () => {
   })
 
   describe('Type tests', () => {
-    const middleware = createActionListenerMiddleware()
+    const middleware = createListenerMiddleware()
     const store = configureStore({
       reducer: counterSlice.reducer,
       middleware: (gDM) => gDM().prepend(middleware),
@@ -1339,7 +1339,7 @@ describe('createActionListenerMiddleware', () => {
     })
 
     test('Can create a pre-typed middleware', () => {
-      const typedMiddleware = createActionListenerMiddleware<CounterState>()
+      const typedMiddleware = createListenerMiddleware<CounterState>()
 
       typedMiddleware.addListener({
         predicate: (

packages/action-listener-middleware/src/tests/useCases.test.ts

@@ -7,7 +7,7 @@ import {
 
 import type { PayloadAction } from '@reduxjs/toolkit'
 
-import { createActionListenerMiddleware } from '../index'
+import { createListenerMiddleware } from '../index'
 
 import type { TypedAddListener } from '../index'
 import { TaskAbortError } from '../exceptions'
@@ -35,11 +35,11 @@ const counterSlice = createSlice({
 const { increment, decrement, incrementByAmount } = counterSlice.actions
 
 describe('Saga-style Effects Scenarios', () => {
-  let middleware: ReturnType<typeof createActionListenerMiddleware>
+  let middleware: ReturnType<typeof createListenerMiddleware>
 
   let store = configureStore({
     reducer: counterSlice.reducer,
-    middleware: (gDM) => gDM().prepend(createActionListenerMiddleware()),
+    middleware: (gDM) => gDM().prepend(createListenerMiddleware()),
   })
 
   const testAction1 = createAction<string>('testAction1')
@@ -58,7 +58,7 @@ describe('Saga-style Effects Scenarios', () => {
   }
 
   beforeEach(() => {
-    middleware = createActionListenerMiddleware()
+    middleware = createListenerMiddleware()
     addListener = middleware.addListener as TypedAddListener<RootState>
     store = configureStore({
       reducer: counterSlice.reducer,