deprecate ActionMatcher, add TypeGuard type

reduxjs · Jan 21, 2022 · e1a3231 · e1a3231
1 parent afb9ccd
commit e1a3231
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 7 deletions.
diff --git a/packages/toolkit/src/createReducer.ts b/packages/toolkit/src/createReducer.ts
@@ -15,8 +15,11 @@ import type { NoInfer } from './tsHelpers'
  */
 export type Actions<T extends keyof any = string> = Record<T, Action>
 
-export interface ActionMatcher<A> {
-  (action: any): action is A
+/**
+ * @deprecated use `TypeGuard` instead
+ */
+export interface ActionMatcher<A extends AnyAction> {
+  (action: AnyAction): action is A
 }
 
 export type ActionMatcherDescription<S, A extends AnyAction> = {

diff --git a/packages/toolkit/src/mapBuilders.ts b/packages/toolkit/src/mapBuilders.ts
@@ -2,9 +2,9 @@ import type { Action, AnyAction } from 'redux'
 import type {
   CaseReducer,
   CaseReducers,
-  ActionMatcher,
   ActionMatcherDescriptionCollection,
 } from './createReducer'
+import type { TypeGuard } from './tsHelpers'
 
 export interface TypedActionCreator<Type extends string> {
   (...args: any[]): Action<Type>
@@ -97,7 +97,7 @@ const reducer = createReducer(initialState, (builder) => {
 ```
    */
   addMatcher<A>(
-    matcher: ActionMatcher<A> | ((action: any) => boolean),
+    matcher: TypeGuard<A> | ((action: any) => boolean),
     reducer: CaseReducer<State, A extends AnyAction ? A : A & AnyAction>
   ): Omit<ActionReducerMapBuilder<State>, 'addCase'>
 
@@ -168,7 +168,7 @@ export function executeReducerBuilderCallback<S>(
       return builder
     },
     addMatcher<A>(
-      matcher: ActionMatcher<A>,
+      matcher: TypeGuard<A>,
       reducer: CaseReducer<S, A extends AnyAction ? A : A & AnyAction>
     ) {
       if (process.env.NODE_ENV !== 'production') {

diff --git a/packages/toolkit/src/tsHelpers.ts b/packages/toolkit/src/tsHelpers.ts
@@ -101,8 +101,12 @@ export type NoInfer<T> = [T][T extends any ? 0 : never]
 
 export type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>
 
+export interface TypeGuard<T> {
+  (value: any): value is T
+}
+
 export interface HasMatchFunction<T> {
-  match: (v: any) => v is T
+  match: TypeGuard<T>
 }
 
 export const hasMatchFunction = <T>(
@@ -112,7 +116,7 @@ export const hasMatchFunction = <T>(
 }
 
 /** @public */
-export type Matcher<T> = HasMatchFunction<T> | ((v: any) => v is T)
+export type Matcher<T> = HasMatchFunction<T> | TypeGuard<T>
 
 /** @public */
 export type ActionFromMatcher<M extends Matcher<any>> = M extends Matcher<