reselect - npm Package Compare versions
Comparing version 5.0.0-rc.0 to 5.0.0-rc.1
@@ -108,3 +108,3 @@ /** | ||
| * They're based on strict reference equality. | ||
| * - It's roughly the same speed as `defaultMemoize`, although likely a fraction slower. | ||
| * - It's roughly the same speed as `lruMemoize`, although likely a fraction slower. | ||
| * | ||
@@ -206,4 +206,4 @@ * __Use Cases for `weakMapMemoize`:__ | ||
| * | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * @template OverrideMemoizeFunction - The type of the optional `memoize` function that could be passed into the options object inside `createSelector` to override the original `memoize` function that was initially passed into `createSelectorCreator`. | ||
@@ -227,3 +227,3 @@ * @template OverrideArgsMemoizeFunction - The type of the optional `argsMemoize` function that could be passed into the options object inside `createSelector` to override the original `argsMemoize` function that was initially passed into `createSelectorCreator`. If none was initially provided, `weakMapMemoize` will be used. | ||
| * The memoize function that is used to memoize the {@linkcode OutputSelectorFields.resultFunc resultFunc} | ||
| * inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * | ||
@@ -252,3 +252,3 @@ * When passed directly into `createSelector`, it overrides the `memoize` function initially passed into `createSelectorCreator`. | ||
| * passed into the output selector generated by `createSelector` | ||
| * (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * | ||
@@ -306,4 +306,4 @@ * When passed directly into `createSelector`, it overrides the | ||
| * @template Result - The type of the result returned by the `resultFunc`. | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * | ||
@@ -360,4 +360,4 @@ * @public | ||
| * @template Result - The type of the result returned by the `resultFunc`. | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * | ||
@@ -505,3 +505,3 @@ * @public | ||
| * | ||
| * `defaultMemoize`, `weakMapMemoize` and `autotrackMemoize` all return these properties. | ||
| * `lruMemoize`, `weakMapMemoize` and `autotrackMemoize` all return these properties. | ||
| * | ||
@@ -712,11 +712,11 @@ * @see {@linkcode ExtractMemoizerFields ExtractMemoizerFields} | ||
| * only recalculates the result if one or more of those accessed fields have changed. | ||
| * This allows it to be more precise than the shallow equality checks in `defaultMemoize`. | ||
| * This allows it to be more precise than the shallow equality checks in `lruMemoize`. | ||
| * | ||
| * __Design Tradeoffs for `autotrackMemoize`:__ | ||
| * - Pros: | ||
| * - It is likely to avoid excess calculations and recalculate fewer times than `defaultMemoize` will, | ||
| * - It is likely to avoid excess calculations and recalculate fewer times than `lruMemoize` will, | ||
| * which may also result in fewer component re-renders. | ||
| * - Cons: | ||
| * - It only has a cache size of 1. | ||
| * - It is slower than `defaultMemoize`, because it has to do more work. (How much slower is dependent on the number of accessed fields in a selector, number of calls, frequency of input changes, etc) | ||
| * - It is slower than `lruMemoize`, because it has to do more work. (How much slower is dependent on the number of accessed fields in a selector, number of calls, frequency of input changes, etc) | ||
| * - It can have some unexpected behavior. Because it tracks nested field accesses, | ||
@@ -779,4 +779,4 @@ * cases where you don't access a field will not recalculate properly. | ||
| * | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * | ||
@@ -841,3 +841,3 @@ * @public | ||
| * | ||
| * @param options - An options object containing the `memoize` function responsible for memoizing the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). It also provides additional options for customizing memoization. While the `memoize` property is mandatory, the rest are optional. | ||
| * @param options - An options object containing the `memoize` function responsible for memoizing the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). It also provides additional options for customizing memoization. While the `memoize` property is mandatory, the rest are optional. | ||
| * @returns A customized `createSelector` function. | ||
@@ -864,4 +864,4 @@ * | ||
| * | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * | ||
@@ -877,3 +877,3 @@ * @see {@link https://github.com/reduxjs/reselect#createselectorcreatormemoize--options-memoizeoptions createSelectorCreator} | ||
| * | ||
| * @param memoize - The `memoize` function responsible for memoizing the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * @param memoize - The `memoize` function responsible for memoizing the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * @param memoizeOptionsFromArgs - Optional configuration options for the memoization function. These options are then passed to the memoize function as the second argument onwards. | ||
@@ -896,3 +896,3 @@ * @returns A customized `createSelector` function. | ||
| * | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * | ||
@@ -916,55 +916,3 @@ * @see {@link https://github.com/reduxjs/reselect#createselectorcreatormemoize--options-memoizeoptions createSelectorCreator} | ||
| /** | ||
| * Runs a simple reference equality check. | ||
| * What {@linkcode defaultMemoize defaultMemoize} uses by default. | ||
| * | ||
| * @public | ||
| */ | ||
| declare const defaultEqualityCheck: EqualityFn; | ||
| /** | ||
| * @public | ||
| */ | ||
| interface DefaultMemoizeOptions<T = any> { | ||
| /** | ||
| * Used to compare the individual arguments of the provided calculation function. | ||
| * | ||
| * @default defaultEqualityCheck | ||
| */ | ||
| equalityCheck?: EqualityFn; | ||
| /** | ||
| * If provided, used to compare a newly generated output value against previous values in the cache. | ||
| * If a match is found, the old value is returned. This addresses the common | ||
| * ```ts | ||
| * todos.map(todo => todo.id) | ||
| * ``` | ||
| * use case, where an update to another field in the original data causes a recalculation | ||
| * due to changed references, but the output is still effectively the same. | ||
| */ | ||
| resultEqualityCheck?: EqualityFn<T>; | ||
| /** | ||
| * The cache size for the selector. If greater than 1, the selector will use an LRU cache internally. | ||
| * | ||
| * @default 1 | ||
| */ | ||
| maxSize?: number; | ||
| } | ||
| /** | ||
| * The standard memoize function used by `createSelector`. | ||
| * @param func - The function to be memoized. | ||
| * @param equalityCheckOrOptions - Either an equality check function or an options object. | ||
| * @returns A memoized function with a `.clearCache()` method attached. | ||
| * | ||
| * @template Func - The type of the function that is memoized. | ||
| * | ||
| * @see {@link https://github.com/reduxjs/reselect#defaultmemoizefunc-equalitycheckoroptions--defaultequalitycheck defaultMemoize} | ||
| * | ||
| * @public | ||
| */ | ||
| declare function defaultMemoize<Func extends AnyFunction>(func: Func, equalityCheckOrOptions?: EqualityFn | DefaultMemoizeOptions<ReturnType<Func>>): Func & { | ||
| clearCache: () => void; | ||
| resultsCount: () => number; | ||
| resetResultsCount: () => void; | ||
| }; | ||
| /** | ||
| * | ||
| * @WIP | ||
@@ -988,3 +936,3 @@ */ | ||
| [Key in keyof RootState]: Selector<RootState, RootState[Key], []>; | ||
| }, MemoizeFunction extends UnknownMemoizer = typeof defaultMemoize, ArgsMemoizeFunction extends UnknownMemoizer = typeof defaultMemoize>(selectors: InputSelectorsObject, selectorCreator?: CreateSelectorFunction<MemoizeFunction, ArgsMemoizeFunction>): OutputSelector<ObjectValuesToTuple<InputSelectorsObject>, SelectorsMap<InputSelectorsObject>, MemoizeFunction, ArgsMemoizeFunction>; | ||
| }, MemoizeFunction extends UnknownMemoizer = typeof weakMapMemoize, ArgsMemoizeFunction extends UnknownMemoizer = typeof weakMapMemoize>(selectors: InputSelectorsObject, selectorCreator?: CreateSelectorFunction<MemoizeFunction, ArgsMemoizeFunction>): OutputSelector<ObjectValuesToTuple<InputSelectorsObject>, SelectorsMap<InputSelectorsObject>, MemoizeFunction, ArgsMemoizeFunction>; | ||
| } | ||
@@ -1076,3 +1024,3 @@ interface SelectorsObject { | ||
| */ | ||
| <InputSelectorsObject extends SelectorsObject, MemoizeFunction extends UnknownMemoizer = typeof defaultMemoize, ArgsMemoizeFunction extends UnknownMemoizer = typeof defaultMemoize>(inputSelectorsObject: InputSelectorsObject, selectorCreator?: CreateSelectorFunction<MemoizeFunction, ArgsMemoizeFunction>): OutputSelector<ObjectValuesToTuple<InputSelectorsObject>, Simplify<SelectorsMap<InputSelectorsObject>>, MemoizeFunction, ArgsMemoizeFunction> & InterruptRecursion; | ||
| <InputSelectorsObject extends SelectorsObject, MemoizeFunction extends UnknownMemoizer = typeof weakMapMemoize, ArgsMemoizeFunction extends UnknownMemoizer = typeof weakMapMemoize>(inputSelectorsObject: InputSelectorsObject, selectorCreator?: CreateSelectorFunction<MemoizeFunction, ArgsMemoizeFunction>): OutputSelector<ObjectValuesToTuple<InputSelectorsObject>, Simplify<SelectorsMap<InputSelectorsObject>>, MemoizeFunction, ArgsMemoizeFunction> & InterruptRecursion; | ||
| } | ||
@@ -1132,2 +1080,76 @@ /** | ||
| /** | ||
| * Runs a simple reference equality check. | ||
| * What {@linkcode lruMemoize lruMemoize} uses by default. | ||
| * | ||
| * **Note**: This function was previously known as `defaultEqualityCheck`. | ||
| * | ||
| * @public | ||
| */ | ||
| declare const referenceEqualityCheck: EqualityFn; | ||
| /** | ||
| * Options for configuring the behavior of a function memoized with | ||
| * LRU (Least Recently Used) caching. | ||
| * | ||
| * @template Result - The type of the return value of the memoized function. | ||
| * | ||
| * @public | ||
| */ | ||
| interface LruMemoizeOptions<Result = any> { | ||
| /** | ||
| * Function used to compare the individual arguments of the | ||
| * provided calculation function. | ||
| * | ||
| * @default referenceEqualityCheck | ||
| */ | ||
| equalityCheck?: EqualityFn; | ||
| /** | ||
| * If provided, used to compare a newly generated output value against | ||
| * previous values in the cache. If a match is found, | ||
| * the old value is returned. This addresses the common | ||
| * ```ts | ||
| * todos.map(todo => todo.id) | ||
| * ``` | ||
| * use case, where an update to another field in the original data causes | ||
| * a recalculation due to changed references, but the output is still | ||
| * effectively the same. | ||
| * | ||
| * @since 4.1.0 | ||
| */ | ||
| resultEqualityCheck?: EqualityFn<Result>; | ||
| /** | ||
| * The maximum size of the cache used by the selector. | ||
| * A size greater than 1 means the selector will use an | ||
| * LRU (Least Recently Used) cache, allowing for the caching of multiple | ||
| * results based on different sets of arguments. | ||
| * | ||
| * @default 1 | ||
| */ | ||
| maxSize?: number; | ||
| } | ||
| /** | ||
| * Creates a memoized version of a function with an optional | ||
| * LRU (Least Recently Used) cache. The memoized function uses a cache to | ||
| * store computed values. Depending on the `maxSize` option, it will use | ||
| * either a singleton cache (for a single entry) or an | ||
| * LRU cache (for multiple entries). | ||
| * | ||
| * **Note**: This function was previously known as `defaultMemoize`. | ||
| * | ||
| * @param func - The function to be memoized. | ||
| * @param equalityCheckOrOptions - Either an equality check function or an options object. | ||
| * @returns A memoized function with a `.clearCache()` method attached. | ||
| * | ||
| * @template Func - The type of the function that is memoized. | ||
| * | ||
| * @see {@link https://github.com/reduxjs/reselect#lrumemoizefunc-equalitycheckoroptions--referenceequalitycheck lruMemoize} | ||
| * | ||
| * @public | ||
| */ | ||
| declare function lruMemoize<Func extends AnyFunction>(func: Func, equalityCheckOrOptions?: EqualityFn | LruMemoizeOptions<ReturnType<Func>>): Func & { | ||
| clearCache: () => void; | ||
| resultsCount: () => number; | ||
| resetResultsCount: () => void; | ||
| }; | ||
| /** | ||
| * Overrides the development mode checks settings for all selectors. | ||
@@ -1178,2 +1200,2 @@ * | ||
| export { Combiner, CreateSelectorFunction, CreateSelectorOptions, DefaultMemoizeFields, DefaultMemoizeOptions, DevModeCheckFrequency, DevModeChecks, DevModeChecksExecutionInfo, EqualityFn, ExtractMemoizerFields, GetParamsFromSelectors, GetStateFromSelectors, MemoizeOptionsFromParameters, OutputSelector, OutputSelectorFields, OverrideMemoizeOptions, Selector, SelectorArray, SelectorResultArray, StructuredSelectorCreator, TypedStructuredSelectorCreator, UnknownMemoizer, createSelector, createSelectorCreator, createStructuredSelector, defaultEqualityCheck, defaultMemoize, setGlobalDevModeChecks, autotrackMemoize as unstable_autotrackMemoize, weakMapMemoize }; | ||
| export { Combiner, CreateSelectorFunction, CreateSelectorOptions, DefaultMemoizeFields, DevModeCheckFrequency, DevModeChecks, DevModeChecksExecutionInfo, EqualityFn, ExtractMemoizerFields, GetParamsFromSelectors, GetStateFromSelectors, LruMemoizeOptions, MemoizeOptionsFromParameters, OutputSelector, OutputSelectorFields, OverrideMemoizeOptions, Selector, SelectorArray, SelectorResultArray, StructuredSelectorCreator, TypedStructuredSelectorCreator, UnknownMemoizer, createSelector, createSelectorCreator, createStructuredSelector, lruMemoize, referenceEqualityCheck, setGlobalDevModeChecks, autotrackMemoize as unstable_autotrackMemoize, weakMapMemoize }; |
@@ -32,4 +32,12 @@ var __defProp = Object.defineProperty; | ||
| if (isInputSameAsOutput) { | ||
| let stack = void 0; | ||
| try { | ||
| throw new Error(); | ||
| } catch (e) { | ||
| ; | ||
| ({ stack } = e); | ||
| } | ||
| console.warn( | ||
| "The result function returned its own inputs without modification. e.g\n`createSelector([state => state.todos], todos => todos)`\nThis could lead to inefficient memoization and unnecessary re-renders.\nEnsure transformation logic is in the result function, and extraction logic is in the input selectors." | ||
| "The result function returned its own inputs without modification. e.g\n`createSelector([state => state.todos], todos => todos)`\nThis could lead to inefficient memoization and unnecessary re-renders.\nEnsure transformation logic is in the result function, and extraction logic is in the input selectors.", | ||
| { stack } | ||
| ); | ||
@@ -46,2 +54,9 @@ } | ||
| if (!areInputSelectorResultsEqual) { | ||
| let stack = void 0; | ||
| try { | ||
| throw new Error(); | ||
| } catch (e) { | ||
| ; | ||
| ({ stack } = e); | ||
| } | ||
| console.warn( | ||
@@ -52,3 +67,4 @@ "An input selector returned a different result when passed same arguments.\nThis means your output selector will likely run more frequently than intended.\nAvoid returning a new reference inside your input selector, e.g.\n`createSelector([state => state.todos.map(todo => todo.id)], todoIds => todoIds.length)`", | ||
| firstInputs: inputSelectorResults, | ||
| secondInputs: inputSelectorResultsCopy | ||
| secondInputs: inputSelectorResultsCopy, | ||
| stack | ||
| } | ||
@@ -396,3 +412,3 @@ ); | ||
| // src/defaultMemoize.ts | ||
| // src/lruMemoize.ts | ||
| function createSingletonCache(equals) { | ||
@@ -448,5 +464,3 @@ let entry; | ||
| } | ||
| var defaultEqualityCheck = (a, b) => { | ||
| return a === b; | ||
| }; | ||
| var referenceEqualityCheck = (a, b) => a === b; | ||
| function createCacheKeyComparator(equalityCheck) { | ||
@@ -466,6 +480,6 @@ return function areArgumentsShallowlyEqual(prev, next) { | ||
| } | ||
| function defaultMemoize(func, equalityCheckOrOptions) { | ||
| function lruMemoize(func, equalityCheckOrOptions) { | ||
| const providedOptions = typeof equalityCheckOrOptions === "object" ? equalityCheckOrOptions : { equalityCheck: equalityCheckOrOptions }; | ||
| const { | ||
| equalityCheck = defaultEqualityCheck, | ||
| equalityCheck = referenceEqualityCheck, | ||
| maxSize = 1, | ||
@@ -489,3 +503,3 @@ resultEqualityCheck | ||
| value = matchingEntry.value; | ||
| resultsCount--; | ||
| resultsCount !== 0 && resultsCount--; | ||
| } | ||
@@ -514,3 +528,3 @@ } | ||
| let lastArgs = null; | ||
| const shallowEqual = createCacheKeyComparator(defaultEqualityCheck); | ||
| const shallowEqual = createCacheKeyComparator(referenceEqualityCheck); | ||
| const cache = createCache(() => { | ||
@@ -735,4 +749,4 @@ const res = func.apply(null, node.proxy); | ||
| createStructuredSelector, | ||
| defaultEqualityCheck, | ||
| defaultMemoize, | ||
| lruMemoize, | ||
| referenceEqualityCheck, | ||
| setGlobalDevModeChecks, | ||
@@ -739,0 +753,0 @@ autotrackMemoize as unstable_autotrackMemoize, |
| { | ||
| "name": "reselect", | ||
| "version": "5.0.0-rc.0", | ||
| "version": "5.0.0-rc.1", | ||
| "description": "Selectors for Redux.", | ||
@@ -32,6 +32,11 @@ "main": "./dist/cjs/reselect.cjs", | ||
| "test": "node --expose-gc ./node_modules/vitest/dist/cli-wrapper.js run", | ||
| "test:watch": "node --expose-gc ./node_modules/vitest/dist/cli-wrapper.js watch", | ||
| "test:cov": "vitest run --coverage", | ||
| "type-check": "vitest --run typecheck", | ||
| "type-check:trace": "vitest --run typecheck && tsc --noEmit -p typescript_test/tsconfig.json --generateTrace trace && npx @typescript/analyze-trace trace && rimraf trace", | ||
| "test:typescript": "tsc --noEmit -p typescript_test/tsconfig.json" | ||
| "test:typescript": "tsc --noEmit -p typescript_test/tsconfig.json", | ||
| "docs:start": "yarn --cwd website start", | ||
| "docs:build": "yarn --cwd website build", | ||
| "docs:clear": "yarn --cwd website clear", | ||
| "docs:serve": "yarn --cwd website serve" | ||
| }, | ||
@@ -72,2 +77,3 @@ "keywords": [ | ||
| "micro-memoize": "^4.0.9", | ||
| "netlify-plugin-cache": "^1.0.3", | ||
| "prettier": "^2.7.1", | ||
@@ -74,0 +80,0 @@ "react": "^18.2.0", |
@@ -6,4 +6,4 @@ import { createNode, updateNode } from './proxy' | ||
| createCacheKeyComparator, | ||
| defaultEqualityCheck | ||
| } from '../defaultMemoize' | ||
| referenceEqualityCheck | ||
| } from '../lruMemoize' | ||
| import type { AnyFunction, DefaultMemoizeFields, Simplify } from '../types' | ||
@@ -18,11 +18,11 @@ import { createCache } from './autotracking' | ||
| * only recalculates the result if one or more of those accessed fields have changed. | ||
| * This allows it to be more precise than the shallow equality checks in `defaultMemoize`. | ||
| * This allows it to be more precise than the shallow equality checks in `lruMemoize`. | ||
| * | ||
| * __Design Tradeoffs for `autotrackMemoize`:__ | ||
| * - Pros: | ||
| * - It is likely to avoid excess calculations and recalculate fewer times than `defaultMemoize` will, | ||
| * - It is likely to avoid excess calculations and recalculate fewer times than `lruMemoize` will, | ||
| * which may also result in fewer component re-renders. | ||
| * - Cons: | ||
| * - It only has a cache size of 1. | ||
| * - It is slower than `defaultMemoize`, because it has to do more work. (How much slower is dependent on the number of accessed fields in a selector, number of calls, frequency of input changes, etc) | ||
| * - It is slower than `lruMemoize`, because it has to do more work. (How much slower is dependent on the number of accessed fields in a selector, number of calls, frequency of input changes, etc) | ||
| * - It can have some unexpected behavior. Because it tracks nested field accesses, | ||
@@ -85,3 +85,3 @@ * cases where you don't access a field will not recalculate properly. | ||
| const shallowEqual = createCacheKeyComparator(defaultEqualityCheck) | ||
| const shallowEqual = createCacheKeyComparator(referenceEqualityCheck) | ||
@@ -88,0 +88,0 @@ const cache = createCache(() => { |
@@ -30,4 +30,4 @@ import { weakMapMemoize } from './weakMapMemoize' | ||
| * | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * | ||
@@ -148,3 +148,3 @@ * @public | ||
| * | ||
| * @param options - An options object containing the `memoize` function responsible for memoizing the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). It also provides additional options for customizing memoization. While the `memoize` property is mandatory, the rest are optional. | ||
| * @param options - An options object containing the `memoize` function responsible for memoizing the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). It also provides additional options for customizing memoization. While the `memoize` property is mandatory, the rest are optional. | ||
| * @returns A customized `createSelector` function. | ||
@@ -171,4 +171,4 @@ * | ||
| * | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * | ||
@@ -200,3 +200,3 @@ * @see {@link https://github.com/reduxjs/reselect#createselectorcreatormemoize--options-memoizeoptions createSelectorCreator} | ||
| * | ||
| * @param memoize - The `memoize` function responsible for memoizing the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * @param memoize - The `memoize` function responsible for memoizing the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * @param memoizeOptionsFromArgs - Optional configuration options for the memoization function. These options are then passed to the memoize function as the second argument onwards. | ||
@@ -219,3 +219,3 @@ * @returns A customized `createSelector` function. | ||
| * | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * | ||
@@ -238,4 +238,4 @@ * @see {@link https://github.com/reduxjs/reselect#createselectorcreatormemoize--options-memoizeoptions createSelectorCreator} | ||
| * | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * @template MemoizeOrOptions - The type of the first argument. It can either be a `memoize` function or an `options` object containing the `memoize` function. | ||
@@ -242,0 +242,0 @@ */ |
| import { createSelector } from './createSelectorCreator' | ||
| import type { CreateSelectorFunction } from './createSelectorCreator' | ||
| import type { defaultMemoize } from './defaultMemoize' | ||
| import type { | ||
@@ -14,2 +13,3 @@ InterruptRecursion, | ||
| import { assertIsObject } from './utils' | ||
| import type { weakMapMemoize } from './weakMapMemoize' | ||
@@ -40,4 +40,4 @@ /** | ||
| }, | ||
| MemoizeFunction extends UnknownMemoizer = typeof defaultMemoize, | ||
| ArgsMemoizeFunction extends UnknownMemoizer = typeof defaultMemoize | ||
| MemoizeFunction extends UnknownMemoizer = typeof weakMapMemoize, | ||
| ArgsMemoizeFunction extends UnknownMemoizer = typeof weakMapMemoize | ||
| >( | ||
@@ -145,4 +145,4 @@ selectors: InputSelectorsObject, | ||
| InputSelectorsObject extends SelectorsObject, | ||
| MemoizeFunction extends UnknownMemoizer = typeof defaultMemoize, | ||
| ArgsMemoizeFunction extends UnknownMemoizer = typeof defaultMemoize | ||
| MemoizeFunction extends UnknownMemoizer = typeof weakMapMemoize, | ||
| ArgsMemoizeFunction extends UnknownMemoizer = typeof weakMapMemoize | ||
| >( | ||
@@ -215,4 +215,4 @@ inputSelectorsObject: InputSelectorsObject, | ||
| InputSelectorsObject extends SelectorsObject, | ||
| MemoizeFunction extends UnknownMemoizer = typeof defaultMemoize, | ||
| ArgsMemoizeFunction extends UnknownMemoizer = typeof defaultMemoize | ||
| MemoizeFunction extends UnknownMemoizer = typeof weakMapMemoize, | ||
| ArgsMemoizeFunction extends UnknownMemoizer = typeof weakMapMemoize | ||
| >( | ||
@@ -219,0 +219,0 @@ inputSelectorsObject: InputSelectorsObject, |
@@ -22,2 +22,9 @@ import type { AnyFunction } from '../types' | ||
| if (isInputSameAsOutput) { | ||
| let stack: string | undefined = undefined | ||
| try { | ||
| throw new Error() | ||
| } catch (e) { | ||
| // eslint-disable-next-line @typescript-eslint/no-extra-semi, no-extra-semi | ||
| ;({ stack } = e as Error) | ||
| } | ||
| console.warn( | ||
@@ -27,5 +34,6 @@ 'The result function returned its own inputs without modification. e.g' + | ||
| '\nThis could lead to inefficient memoization and unnecessary re-renders.' + | ||
| '\nEnsure transformation logic is in the result function, and extraction logic is in the input selectors.' | ||
| '\nEnsure transformation logic is in the result function, and extraction logic is in the input selectors.', | ||
| { stack } | ||
| ) | ||
| } | ||
| } |
@@ -34,3 +34,9 @@ import type { CreateSelectorOptions, UnknownMemoizer } from '../types' | ||
| if (!areInputSelectorResultsEqual) { | ||
| // do we want to log more information about the selector? | ||
| let stack: string | undefined = undefined | ||
| try { | ||
| throw new Error() | ||
| } catch (e) { | ||
| // eslint-disable-next-line @typescript-eslint/no-extra-semi, no-extra-semi | ||
| ;({ stack } = e as Error) | ||
| } | ||
| console.warn( | ||
@@ -44,3 +50,4 @@ 'An input selector returned a different result when passed same arguments.' + | ||
| firstInputs: inputSelectorResults, | ||
| secondInputs: inputSelectorResultsCopy | ||
| secondInputs: inputSelectorResultsCopy, | ||
| stack | ||
| } | ||
@@ -47,0 +54,0 @@ ) |
@@ -9,4 +9,4 @@ export { autotrackMemoize as unstable_autotrackMemoize } from './autotrackMemoize/autotrackMemoize' | ||
| } from './createStructuredSelector' | ||
| export { defaultEqualityCheck, defaultMemoize } from './defaultMemoize' | ||
| export type { DefaultMemoizeOptions } from './defaultMemoize' | ||
| export { lruMemoize, referenceEqualityCheck } from './lruMemoize' | ||
| export type { LruMemoizeOptions } from './lruMemoize' | ||
| export { setGlobalDevModeChecks } from './devModeChecks/setGlobalDevModeChecks' | ||
@@ -13,0 +13,0 @@ export type { |
@@ -57,4 +57,4 @@ import type { MergeParameters } from './versionedTypes' | ||
| * | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * @template OverrideMemoizeFunction - The type of the optional `memoize` function that could be passed into the options object inside `createSelector` to override the original `memoize` function that was initially passed into `createSelectorCreator`. | ||
@@ -84,3 +84,3 @@ * @template OverrideArgsMemoizeFunction - The type of the optional `argsMemoize` function that could be passed into the options object inside `createSelector` to override the original `argsMemoize` function that was initially passed into `createSelectorCreator`. If none was initially provided, `weakMapMemoize` will be used. | ||
| * The memoize function that is used to memoize the {@linkcode OutputSelectorFields.resultFunc resultFunc} | ||
| * inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * | ||
@@ -110,3 +110,3 @@ * When passed directly into `createSelector`, it overrides the `memoize` function initially passed into `createSelectorCreator`. | ||
| * passed into the output selector generated by `createSelector` | ||
| * (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * | ||
@@ -176,4 +176,4 @@ * When passed directly into `createSelector`, it overrides the | ||
| * @template Result - The type of the result returned by the `resultFunc`. | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * | ||
@@ -251,4 +251,4 @@ * @public | ||
| * @template Result - The type of the result returned by the `resultFunc`. | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `defaultMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * @template MemoizeFunction - The type of the memoize function that is used to memoize the `resultFunc` inside `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). | ||
| * @template ArgsMemoizeFunction - The type of the optional memoize function that is used to memoize the arguments passed into the output selector generated by `createSelector` (e.g., `lruMemoize` or `weakMapMemoize`). If none is explicitly provided, `weakMapMemoize` will be used. | ||
| * | ||
@@ -450,3 +450,3 @@ * @public | ||
| * | ||
| * `defaultMemoize`, `weakMapMemoize` and `autotrackMemoize` all return these properties. | ||
| * `lruMemoize`, `weakMapMemoize` and `autotrackMemoize` all return these properties. | ||
| * | ||
@@ -453,0 +453,0 @@ * @see {@linkcode ExtractMemoizerFields ExtractMemoizerFields} |
@@ -102,3 +102,3 @@ // Original source: | ||
| * They're based on strict reference equality. | ||
| * - It's roughly the same speed as `defaultMemoize`, although likely a fraction slower. | ||
| * - It's roughly the same speed as `lruMemoize`, although likely a fraction slower. | ||
| * | ||
@@ -105,0 +105,0 @@ * __Use Cases for `weakMapMemoize`:__ |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by1.21%
654689
- Lines of code
- increased by1.58%
6219
- Number of lines in readme file
- increased by1.35%
1950
Worsened metrics
- Dev dependency count
- increased by3.7%
28
No dependency changes