Improve useDebounce callback type#2701
Open
itsmejay80 wants to merge 2 commits intostreamich:masterfrom
Open
Conversation
There was a problem hiding this comment.
Pull request overview
This PR refines the TypeScript typing for useDebounce’s callback parameter, aiming to avoid the overly-broad Function type and document the updated signature.
Changes:
- Updated
useDebounceto accept a constrained callback type instead ofFunction. - Added a
UseDebounceFntype alias for the callback. - Updated
useDebouncedocumentation reference signature and parameter type description.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/useDebounce.ts | Tightens the callback parameter typing for useDebounce. |
| docs/useDebounce.md | Updates the reference section to reflect the new callback typing. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or 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
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.
Fixes #2677
Description
Updates
useDebounceto type the callback as a callable instead of the broadFunctiontype. The callable is constrained to zero arguments becauseuseDebounceschedules the callback throughuseTimeoutFn, which invokes it without forwarding arguments.Runtime behavior and the existing
[isReady, cancel]return type are unchanged.Validation
yarn lint:typesyarn test tests/useDebounce.test.tsyarn lint(passes with existing warnings)Type of change
Checklist
yarn test)yarn lint). Fix it withyarn lint:fixin case of failure.yarn lint:types).