Skip to content

Commit 5d39ecf

Browse files
committed
Rename removeAllListeners to clearAllListeners
1 parent cb97bfa commit 5d39ecf

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

docs/api/createListenerMiddleware.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -259,12 +259,12 @@ Returns `true` if the `options.listener` listener has been removed, `false` if n
259259
store.dispatch(removeListener({ predicate, listener }))
260260
```
261261

262-
### `removeAllListeners`
262+
### `clearAllListeners`
263263

264264
A standard RTK action creator, imported from the package. Dispatching this action tells the middleware to dynamically remove all listeners at runtime.
265265

266266
```js
267-
store.dispatch(removeAllListeners())
267+
store.dispatch(clearAllListeners())
268268
```
269269

270270
## Listener API

packages/toolkit/src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,6 @@ export {
178178
createListenerMiddleware,
179179
addListener,
180180
removeListener,
181-
removeAllListeners,
181+
clearAllListeners,
182182
TaskAbortError,
183183
} from './listenerMiddleware/index'

packages/toolkit/src/listenerMiddleware/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -266,7 +266,7 @@ export const addListener = createAction(
266266
/**
267267
* @alpha
268268
*/
269-
export const removeAllListeners = createAction(`${alm}/removeAll`)
269+
export const clearAllListeners = createAction(`${alm}/removeAll`)
270270

271271
/**
272272
* @alpha
@@ -405,7 +405,7 @@ export function createListenerMiddleware<
405405
return startListening(action.payload)
406406
}
407407

408-
if (removeAllListeners.match(action)) {
408+
if (clearAllListeners.match(action)) {
409409
clearListenerMiddleware()
410410
return
411411
}

packages/toolkit/src/listenerMiddleware/tests/listenerMiddleware.test.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import {
1414
addListener,
1515
removeListener,
1616
TaskAbortError,
17-
removeAllListeners,
17+
clearAllListeners,
1818
} from '../index'
1919

2020
import type {
@@ -649,7 +649,7 @@ describe('createListenerMiddleware', () => {
649649
})
650650

651651
startListening({
652-
actionCreator: removeAllListeners,
652+
actionCreator: clearAllListeners,
653653
effect() {
654654
listener2Calls++
655655
},
@@ -663,7 +663,7 @@ describe('createListenerMiddleware', () => {
663663
})
664664

665665
store.dispatch(testAction1('a'))
666-
store.dispatch(removeAllListeners())
666+
store.dispatch(clearAllListeners())
667667
store.dispatch(testAction1('b'))
668668
expect(await listener1Test).toBe(1)
669669
expect(listener1Calls).toBe(1)

0 commit comments

Comments
 (0)