update useSelector() ts example in API Reference #2153
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Hooks API Reference provides a simplified typescript definition for
useSelector()
that defines a type alias forSelectorFn
, but then usesSelectorFunction
in place of that type later in the example. This PR replaces theSelectorFunction
usage withSelectorFn
, and adds a generic type parameter toEqualityFn
to resemble the definition ofSelectorFn
more closely, and updates the name of the equalityFn parameter to equalityFnOrOptions to match its current name in v8.The example also puts an assignment statement
const result: Selected =
before a function declaration foruseSelector
, which is technically invalid typescript. Its meaning is clear, but it does not match how other hook API functions with parameters likecreateStoreHook
,createDispatchHook
, andcreateSelectorHook
are introduced in the docs. With this in mind, it may be better to provide the type definition foruseSelector
in the example, and put the assignment statement in an inline comment instead:Issue: #2152