Add JSDocs for CreateSelectorOptions.identityFunctionCheck

reduxjs · Nov 26, 2023 · 6841bf3 · 6841bf3
1 parent f3aa146
commit 6841bf3
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/src/createSelectorCreator.ts b/src/createSelectorCreator.ts
@@ -217,7 +217,7 @@ let globalIdentityFunctionCheck: DevModeCheckFrequency = 'once'
  * setGlobalIdentityFunctionCheck('never')
  * ```
  * @see {@link https://github.com/reduxjs/reselect#debugging-tools debugging-tools}
- * @see {@link https://github.com/reduxjs/reselect#1-globally-through-setGlobalIdentityFunctionCheck global-configuration}
+ * @see {@link https://github.com/reduxjs/reselect#1-globally-through-setglobalidentityfunctioncheck global-configuration}
  *
  * @since 5.0.0
  * @public

diff --git a/src/types.ts b/src/types.ts
@@ -83,6 +83,20 @@ export interface CreateSelectorOptions<
    */
   inputStabilityCheck?: DevModeCheckFrequency
 
+  /**
+   * Overrides the global identity function check for the selector.
+   * - `once` - Run only the first time the selector is called.
+   * - `always` - Run every time the selector is called.
+   * - `never` - Never run the identity function check.
+   *
+   * @default 'once'
+   *
+   * @see {@link https://github.com/reduxjs/reselect#debugging-tools debugging-tools}
+   * @see {@link https://github.com/reduxjs/reselect#identityfunctioncheck identityFunctionCheck}
+   * @see {@link https://github.com/reduxjs/reselect#2-per-selector-by-passing-an-identityfunctioncheck-option-directly-to-createselector per-selector-configuration}
+   *
+   * @since 5.0.0
+   */
   identityFunctionCheck?: DevModeCheckFrequency
 
   /**