Rename noopCheck to identityFunctionCheck

Author: aryaemami59

docs/api/hooks.md

@@ -53,7 +53,7 @@ export type CheckFrequency = 'never' | 'once' | 'always'
 interface UseSelectorOptions {
   equalityFn?: EqualityFn
   stabilityCheck?: CheckFrequency
-  noopCheck?: CheckFrequency
+  identityFunctionCheck?: CheckFrequency
 }
 
 const result: Selected = useSelector(
@@ -303,7 +303,7 @@ function Component() {
 }
 ```
 
-#### No-op selector check
+#### `identityFunctionCheck`
 
 In development, a check is conducted on the result returned by the selector. It warns in the console if the result is the same as the parameter passed in, i.e. the root state.
 
@@ -321,16 +321,16 @@ const user = useSelector((state) => state.auth.currentUser)
 By default, this will only happen when the selector is first called. You can configure the check in the Provider or at each `useSelector` call.
 
 ```tsx title="Global setting via context"
-<Provider store={store} noopCheck="always">
+<Provider store={store} identityFunctionCheck="always">
   {children}
 </Provider>
 ```
 
 ```tsx title="Individual hook setting"
 function Component() {
-  const count = useSelector(selectCount, { noopCheck: 'never' })
+  const count = useSelector(selectCount, { identityFunctionCheck: 'never' })
   // run once (default)
-  const user = useSelector(selectUser, { noopCheck: 'once' })
+  const user = useSelector(selectUser, { identityFunctionCheck: 'once' })
   // ...
 }
 ```

src/components/Context.ts

@@ -1,8 +1,8 @@
-import * as React from 'react'
 import type { Context } from 'react'
+import * as React from 'react'
 import type { Action, Store, UnknownAction } from 'redux'
-import type { Subscription } from '../utils/Subscription'
 import type { CheckFrequency } from '../hooks/useSelector'
+import type { Subscription } from '../utils/Subscription'
 
 export interface ReactReduxContextValue<
   SS = any,
@@ -12,7 +12,7 @@ export interface ReactReduxContextValue<
   subscription: Subscription
   getServerState?: () => SS
   stabilityCheck: CheckFrequency
-  noopCheck: CheckFrequency
+  identityFunctionCheck: CheckFrequency
 }
 
 const ContextKey = Symbol.for(`react-redux-context`)

src/components/Provider.tsx

@@ -32,8 +32,8 @@ export interface ProviderProps<
   /** Global configuration for the `useSelector` stability check */
   stabilityCheck?: CheckFrequency
 
-  /** Global configuration for the `useSelector` no-op check */
-  noopCheck?: CheckFrequency
+  /** Global configuration for the `useSelector` identity function check */
+  identityFunctionCheck?: CheckFrequency
 
   children: ReactNode
 }
@@ -44,7 +44,7 @@ function Provider<A extends Action<string> = UnknownAction, S = unknown>({
   children,
   serverState,
   stabilityCheck = 'once',
-  noopCheck = 'once',
+  identityFunctionCheck = 'once',
 }: ProviderProps<A, S>) {
   const contextValue = React.useMemo(() => {
     const subscription = createSubscription(store)
@@ -53,9 +53,9 @@ function Provider<A extends Action<string> = UnknownAction, S = unknown>({
       subscription,
       getServerState: serverState ? () => serverState : undefined,
       stabilityCheck,
-      noopCheck,
+      identityFunctionCheck,
     }
-  }, [store, serverState, stabilityCheck, noopCheck])
+  }, [store, serverState, stabilityCheck, identityFunctionCheck])
 
   const previousState = React.useMemo(() => store.getState(), [store])
 

src/hooks/useSelector.ts

@@ -1,21 +1,21 @@
 import * as React from 'react'
 
-import {
-  createReduxContextHook,
-  useReduxContext as useDefaultReduxContext,
-} from './useReduxContext'
 import type { ReactReduxContextValue } from '../components/Context'
 import { ReactReduxContext } from '../components/Context'
 import type { EqualityFn, NoInfer } from '../types'
 import type { uSESWS } from '../utils/useSyncExternalStore'
 import { notInitialized } from '../utils/useSyncExternalStore'
+import {
+  createReduxContextHook,
+  useReduxContext as useDefaultReduxContext,
+} from './useReduxContext'
 
 export type CheckFrequency = 'never' | 'once' | 'always'
 
 export interface UseSelectorOptions<Selected = unknown> {
   equalityFn?: EqualityFn<Selected>
   stabilityCheck?: CheckFrequency
-  noopCheck?: CheckFrequency
+  identityFunctionCheck?: CheckFrequency
 }
 
 export interface UseSelector {
@@ -62,7 +62,7 @@ export function createSelectorHook(
     const {
       equalityFn = refEquality,
       stabilityCheck = undefined,
-      noopCheck = undefined,
+      identityFunctionCheck = undefined,
     } = typeof equalityFnOrOptions === 'function'
       ? { equalityFn: equalityFnOrOptions }
       : equalityFnOrOptions
@@ -85,7 +85,7 @@ export function createSelectorHook(
       subscription,
       getServerState,
       stabilityCheck: globalStabilityCheck,
-      noopCheck: globalNoopCheck,
+      identityFunctionCheck: globalIdentityFunctionCheck,
     } = useReduxContext()
 
     const firstRun = React.useRef(true)
@@ -125,11 +125,11 @@ export function createSelectorHook(
                 )
               }
             }
-            const finalNoopCheck =
-              typeof noopCheck === 'undefined' ? globalNoopCheck : noopCheck
+            const finalIdentityFunctionCheck =
+              typeof identityFunctionCheck === 'undefined' ? globalIdentityFunctionCheck : identityFunctionCheck
             if (
-              finalNoopCheck === 'always' ||
-              (finalNoopCheck === 'once' && firstRun.current)
+              finalIdentityFunctionCheck === 'always' ||
+              (finalIdentityFunctionCheck === 'once' && firstRun.current)
             ) {
               // @ts-ignore
               if (selected === state) {

test/hooks/useSelector.spec.tsx

@@ -33,14 +33,14 @@ import type { UseSelectorOptions } from '../../src/hooks/useSelector'
 // disable checks by default
 function ProviderMock<A extends Action<any> = AnyAction, S = unknown>({
   stabilityCheck = 'never',
-  noopCheck = 'never',
+  identityFunctionCheck = 'never',
   ...props
 }: ProviderProps<A, S>) {
   return (
     <Provider
       {...props}
       stabilityCheck={stabilityCheck}
-      noopCheck={noopCheck}
+      identityFunctionCheck={identityFunctionCheck}
     />
   )
 }
@@ -1028,10 +1028,10 @@ describe('React', () => {
             expect(selector).toHaveBeenCalledTimes(4)
           })
         })
-        describe('no-op selector check', () => {
+        describe('identity function check', () => {
           it('warns for selectors that return the entire root state', () => {
             rtl.render(
-              <ProviderMock noopCheck="once" store={normalStore}>
+              <ProviderMock identityFunctionCheck="once" store={normalStore}>
                 <RenderSelector selector={(state) => state.count} />
               </ProviderMock>
             )
@@ -1041,7 +1041,7 @@ describe('React', () => {
             rtl.cleanup()
 
             rtl.render(
-              <ProviderMock noopCheck="once" store={normalStore}>
+              <ProviderMock identityFunctionCheck="once" store={normalStore}>
                 <RenderSelector selector={(state) => state} />
               </ProviderMock>
             )