useSelect: Make deps optional param. #66187
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
torounit
added
[Type] Bug
|
Size Change: 0 B Total Size: 1.81 MB ℹ️ View Unchanged
|
|
Flaky tests detected in d812f9c. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/11587936170
|
|
The function useSelect( store: StoreDescriptor ): StoreSelectors;
function useSelect<T>( mapSelect: MapCallback<T>, deps: unknown[] ): T;Is it possible to express this also in JSDoc? Two signatures, no optional params. |
|
@jsnajdr Thank you for your review! I tried to get the following signatures built using |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What?
Update jsdoc to explicitly state that deps is optional.
Why?
The deps parameter in useSelect is optional, allowing usage such as const { getSettings } = useSelect( myCustomStore ). However, in the built type information, deps is set as a required parameter, causing this code to throw an error when using TypeScript. Therefore, we will revise the JSDoc to modify the generated type information.
Testing Instructions