Selector library for Redux
This release updates the TS types to work correctly with TS 4.9, which made a change that broke the existing MergeParameters type implementation. Happily, the TS team provided a better (and simpler!) MergeParameters implementation. Since that only works with TS 4.7+, we've reworked the internals to handle providing the old implementation to TS 4.2..4.6, and the new implementation to TS 4.7 and greater.
As a user, there should be no visible change - just update to 4.1.7.
Full Changelog: https://github.com/reduxjs/reselect/compare/v4.1.6...v4.1.7
This release updates the TS types to better handle cases with default parameters, or any/unknown types.
Full Changelog: https://github.com/reduxjs/reselect/compare/v4.1.5...v4.1.6
This release updates the TS types to correctly infer selector parameters when input selectors have undefined or null as a parameter type or have optional parameters, and exports the CreateSelectorFunction type to fix uses of createStructuredSelector.
(The types fixes feel like playing whack-a-mole, but they keep getting better!
Full Changelog: https://github.com/reduxjs/reselect/compare/v4.1.4...v4.1.5
This release has (you guessed it) more fixes to the TS types: a change to parameter merging that fixes breakage with selectors and RTK Query's API state, a simplification of the OutputSelectorFields type to improve selector variable readability, another update to parameter merging to flag nested never fields as compile errors, and a fix to createStructuredSelector parameters to resolve a lib compilation problem.
The parameter merging fixes in 4.1.3 tried to "unwrap/expand" the parameter types to make them more readable, such as showing intersected objects as {a, b, c} instead of {a} & {b} & {c}. This was done with a recursive expansion type. That turned out to break with the complex state types used by RTK Query. We've updated the type expansion to only be a single level instead, which fixes the compilation issue.
The OutputSelectorFields type previously took two generics: the Combiner function, and a Result type. This led to extra values being shown in hover previews for selectors. By inferring Result = ReturnType<Combiner>, we were able to drop the second generic and cut down on the amount of types shown in previews.
A user noted that intersected objects with top-level incompatible fields (like {a: string} & {a: number}) resulted in empty objects, but no compile error. We've updated the parameter merging to flag those as never and catch the problem at compile time. Deeper nested incompatible fields should already be caught by TS.
The previous fix to createStructuredSelector missed a step in the spreading process, which has now been fixed.
Full Changelog: https://github.com/reduxjs/reselect/compare/v4.1.3...v4.1.4
This release rewrites the TS type inference of input selector parameters for correctness, fixes inference of createStructuredSelector inputs, and fixes an issue with the OutputSelectorFields type not being exported.
Reselect's types have always been extremely tricky, because it involves passing multiple input selectors with potentially heterogeneous, and then nested function composition of multiple selectors. Additionally, the input selectors can be passed as individual arguments or a single array of input selectors.
The 4.0.0 typedefs dealt with this by hand-writing dozens of overloads, which was absolutely impossible to maintain.
In 4.1, we took advantage of TS's improved abilities to infer array/tuple types to consolidate the typedefs.
One of the issues that happened as a result was that arguments at the same input parameter index were being "unioned" together, rather than "intersectioned". For example, in this complex selector:
const input1 = (
_: StateA,
{ testNumber }: { testNumber: number },
c: number,
d: string
) => testNumber
const input2 = (
_: StateA,
{ testString }: { testString: string },
c: number | string
) => testString
const input3 = (
_: StateA,
{ testBoolean }: { testBoolean: boolean },
c: number | string,
d: string
) => testBoolean
const input4 = (_: StateA, { testString2 }: { testString2: string }) =>
testString2
const testSelector = createSelector(
input1,
input2,
input3,
input4,
(testNumber, testString, testBoolean) => testNumber + testString
)
The second arg should end up as an object like {testNumber: number, testString: string, testBoolean: boolean, testString2: string}. However, it was ending up as four separate one-field objects. Similarly, the combination of number and number | string should be narrowed down to just number as an acceptable value.
We've rewritten the types to successfully accomplish that (although it took a lot of collective effort and headbanging to actually pull this off!) This should now give much more correct results when determining the final parameters that can be passed to a selector.
createStructuredSelector FixesSimilarly, createStructuredSelector wasn't always inferring its arguments properly. We were able to reuse the parameter inference work here as well.
OutputSelectorFields ExportedThe public OutputSelector type depended on an internal OutputSelectorFields type, but since OSF wasn't being exported, TS would throw errors when trying to generate declaration files that exported selectors. That is now public as well.
Full Changelog: https://github.com/reduxjs/reselect/compare/v4.1.2...v4.1.3
This release updates the TS types to avoid TypeScript recursion limitations and improve backwards compatibility, adds doc comments to most of the TS types and field declarations, and fixes a bug with the behavior of the resultEqualityCheck option in defaultMemoize.
We saw cases where composition of selectors past 8-9 levels of nesting would cause TS to fail with a "Type instantiation is excessively deep and possibly infinite" error.
We've updated the types to allow additional recursion up to about 15 levels of nested selectors. Hopefully this is enough for most usages :)
The OutputSelector generic arguments had been swapped during the rewrite for 4.1, which made it incompatible with other code that attempted to import and use that type. We've reverted the generic arguments to their previous order to fix compatibility.
defaultMemoize adds a .clearCache() field to its return value. While the real caching is done by the memoizedResultFunc function, the actual returned selector has also been run through the memoizer and thus also has a .clearCache() field attached, but that wasn't captured in the types. We've updated the types to reflect that.
We've also added doc comments to almost all of the internal types for clarity, as well as comments to the returned fields on selectors.
resultEqualityCheck BehaviorThe resultEqualityCheck option wasn't saving the result if there was a cache hit, which is now fixed.
Full Changelog: https://github.com/reduxjs/reselect/compare/v4.1.1...v4.1.2
This releases fixes several TS issues and one runtime issue that were reported with the release of 4.1.0.
All these reported issues should now be fixed:
createSelector calls with 12 or more input selectors were causing TS to fail with a "Type instantiation is excessively deep" error. After this update, createSelector should now support up to 29 input selectors before TS has type issues. (and if you've got more than 29 input selectors.... what are you doing? :) )(a: number) => 42, (b: string) => 123)OutputParametricSelector type, which is re-exported by Redux Toolkit, was inadvertently left out of the list of Reselect type exports during the rewrite and caused RTK builds to failSomeType | undefined were causing the entire selector to be typed as possibly returning undefined
The previous internal cache logic had a couple of if (foundValue !== undefined) checks inside, but that broke cases where a selector intentionally wanted to return undefined as the actual result.
The cache logic has been updated to use an internal sentinel value as the NOT_FOUND result instead, allowing undefined to be correctly cached and returned.
GetStateFromSelectors by @phryneas in https://github.com/reduxjs/reselect/pull/529
undefined by @markerikson in https://github.com/reduxjs/reselect/pull/532
Full Changelog: https://github.com/reduxjs/reselect/compare/v4.1.0...v4.1.1
This long-overdue release updates defaultMemoize to accept new options for cache size > 1 and a result equality check, updates createSelector to accept an options object containing options for the provided memoize function, makes major improvements to the TypeScript types (targeting TS 4.2+), converts the codebase to TS, improves some error messages, and adds memoizedResultFunc and lastResult to the fields attached to the selector,
This should be a drop-in update - the only expected backwards compatibility issues are with incorrect or very outdated TypeScript usage patterns.
Update: see https://github.com/reduxjs/reselect/releases/tag/v4.1.1 for fixes to several TS and other issues that were reported with the 4.1.0 release
npm i reselect@latest
yarn add reselect@latest
defaultMemoize OptionsdefaultMemoize has always been fairly limited. Its signature was (func: Function, equalityCheck?: EqualityFn) => Function, and only ever had a cache size of 1. This has led to many annoyances and workarounds, typically involving calling createSelectorCreator() with a custom memoization function that has a larger cache size or more options for customizing comparisons.
We've updated defaultMemoize to allow cache sizes > 1, as well as customize comparisons of the newly generated result value to improve cache hits.
The signature for defaultMemoize is now:
interface DefaultMemoizeOptions {
equalityCheck?: EqualityFn
resultEqualityCheck?: EqualityFn
maxSize?: number
}
// defaultMemoize now supports a configurable cache size with LRU behavior,
// and optional comparison of the result value with existing values
export function defaultMemoize<F extends (...args: any[]) => any>(
func: F,
equalityCheckOrOptions?: EqualityFn | DefaultMemoizeOptions
): F
In other words, you can still pass equalityCheck as its one additional arg, or you may pass an object containing several possible options.
If the maxSize value is greater than 1, defaultMemoize will now use an LRU cache based on https://github.com/erikras/lru-memoize internally.
If resultEqualityCheck is provided, it will be used to compare the newly-generated value from func against all other values in the cache, in LRU order. If a cached value is found to be equal, that value will be returned. This addresses the common todos.map(todo => todo.id) use case, where a change to any field in any todo object creates a new todos array and thus causes the output to be recalculated, but the generated IDs array is still shallow-equal to the last result. You can now pass an equality function like shallowEqual as the resultEqualityCheck argument, and it will reuse the old IDs array instead.
createSelector OptionsPreviously, the only way to customize behavior of createSelector was to generate a customized version with createSelectorCreator. By far the most common use case was customizing the equalityCheck option used with defaultMemoize, or using a different memoizer entirely. This usually looked like:
const createShallowEqualSelector = createSelectorCreator(defaultMemoize, shallowEqual)
const createDeepEqualSelector = createSelectorCreator(defaultMemoize, _.isEqual)
const createCustomComparisonSelector = createSelector(_.memoize, hashFn)
createSelectorCreator also accepted additional positional parameters, and forwarded all of them to the provided memoize function, so defaultMemoize ultimately gets called internally as defaultMemoize(actualFunction, shallowEqual).
This added an annoying level of indirection to common customization use cases.
createSelector now accepts an options object as its last argument, after the output selector. Currently, that object only includes one field: memoizeOptions:
interface CreateSelectorOptions<MemoizeOptions extends unknown[]> {
memoizeOptions: MemoizeOptions[0] | MemoizeOptions
}
Similar to how createSelectorCreator accepts additional "options args" that get forwarded to the memoization function, the memoizeOptions field accepts an array of those "options args" as well. If provided, these override what was given to createSelectorCreator.
That means that you can now customize memoization behavior with direct options to createSelector. And, because defaultMemoize now accepts more options, you can directly customize defaultMemoize's behavior without using createSelectorCreator.
Additionally, because it's very common to only need to pass one options arg to the memoization function, memoizeOptions may also be just that first options arg by itself, without any array.
Example usages of this look like:
const createSelectorAcceptsArgsAsArray = createSelector(
(state: StateAB) => state.a,
(state: StateAB) => state.b,
(a, b) => a + b,
{
// Pass `equalityCheck`, the first options arg of `defaultMemoize`, in an array
memoizeOptions: [(a, b) => a === b]
}
)
const createSelectorFirstArgDirectly = createSelector(
(state: StateAB) => state.a,
(state: StateAB) => state.b,
(a, b) => a + b,
{
// Pass `equalityCheck`, the first options arg of `defaultMemoize`, directly
memoizeOptions: (a, b) => a === b
}
)
const defaultMemoizeAcceptsFirstArgAsObject = createSelector(
(state: StateAB) => state.a,
(state: StateAB) => state.b,
(a, b) => a + b,
{
// Pass `options`, the _alternate_ first arg of `defaultMemoize`, directly
memoizeOptions: {
equalityCheck: (a, b) => a === b,
maxSize: 10,
resultEqualityCheck: shallowEqual
}
}
)
// Can still create custom selectors by passing args to `createSelectorCreator`
const customSelectorCreatorMicroMemoize = createSelectorCreator(
microMemoize,
{
maxSize: 42
}
)
This should make it much easier to customize behavior.
All of this is fully TypeScript-typed, and the possible values for memoizeOptions should be fully inferred from the provided memoize function.
Additionally, defaultMemoize now supports clearing the cache inside a memoized function (regardless of cache size). The memoized function returned from defaultMemoize will now have a .clearCache() method attached that will clear the cache.
When using createSelector, this can be accessed using selector.memoizedResultFunc.clearCache().
The Reselect types were written several years ago and originally targeted TS 2.x versions. As a result, the typedefs requires dozens of overloads to handle varying numbers of arguments (see the legacy typedefs file for examples).
We've converted the codebase to be written in TypeScript, and as part of that process we've completely rewritten the TS typedefs to use modern TS syntax like mapped types. This drastically shrinks the size of the typedefs (from 1000 lines to about 115), and also improves the actual type inference overall. Assuming the input selectors are correctly and consistently typed, TS will now fully infer the return values of all input selectors, the arguments to the output selector, and the exact type of the memoized function.
The updated types do require use of TS 4.2+. We've attempted to keep the final public type names and usage the same, but there may also be some types breakage. We'd appreciate feedback on any meaningful breakage issues so we can make further tweaks if needed.
Given the intent of the improvements, that they're all type-only changes, the attempts to retain backwards compatibility, and TS's own versioning scheme, we're considering this to be a minor version change rather than a major.
In pre-release testing, the main issues we saw were:
state arg. Fix: explicitly add a type to state
<A, B, C, D> generics from the createSelector() call.The legacy types are still included, and should automatically be used if you are using TS 4.1 and earlier. Note that the legacy types do not include the definitions for the new defaultMemoize options - you'll need to be on TS 4.2+ to use those with TS.
We've improved the error messages thrown when invalid selectors are provided.
Generated selectors now include selector.memoizedResultFunc and selector.lastResult for later access if needed.
The early alphas contained code from several outstanding PRs, pulled together:
memoize type fixes ( @micahbales )createStructuredSelector inference ( @oatkiller )Additional work included:
defaultMemoize to accept options (maxSize, equalityCheck, resultEqualityCheck) by @markerikson in https://github.com/reduxjs/reselect/pull/513
clearCache method to defaultMemoize output functions by @markerikson in https://github.com/reduxjs/reselect/pull/519
Full Changelog: https://github.com/reduxjs/reselect/compare/v4.0.0...v4.1.0
This release fixes an issue with the typesVersions package field so that TS 4.1 and earlier correctly pick up the legacy type definitions - no other code changes.
npm i reselect@next
yarn add reselect@next
-Fix typesVersions syntax to work with TS 4.1 and earlier 4ebcc36
https://github.com/reduxjs/reselect/compare/v4.1.0-beta.1...v4.1.0-beta.2
This release fixes a couple test-related packages that were accidentally listed as dependencies instead of devDependencies, and adds the sideEffects flag to package.json in case it's useful.
There are no code changes from 4.1.0-beta.0: https://github.com/reduxjs/reselect/releases/tag/v4.1.0-beta.0
npm i reselect@next
yarn add reselect@next
Full Changelog: https://github.com/reduxjs/reselect/compare/v4.1.0-beta.0...v4.1.0-beta.1