Document usage of debounced setter in README #200
Conversation
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
Added section on using the debounced setter with example.
xnimorz
requested changes
Sep 3, 2025
Owner
xnimorz
left a comment
xnimorz
left a comment
There was a problem hiding this comment.
I don't think it's needed. If you want to add information of a setter inside a tuple, I suggest adding it right after the example of usage.
Comment on lines
+101
to
+113
| import React from 'react'; | ||
| import { useDebounce } from 'use-debounce'; | ||
|
|
||
| export default function Input() { | ||
| const [state, setState] = useDebounce('', 300); | ||
|
|
||
| return ( | ||
| <div> | ||
| <input onChange={(e) => setState(e.target.value)} /> | ||
| <p>Debounced value: {state}</p> | ||
| </div> | ||
| ); | ||
| } |
Owner
There was a problem hiding this comment.
The same example exist right above the added section.
I don't think repetition is needed here
|
|
||
| ### Using the debounced setter | ||
|
|
||
| In addition to getting the debounced value, you can destructure a second element which is a debounced setter function. This allows you to use `useDebounce` without needing a separate state variable for the input value: |
Owner
There was a problem hiding this comment.
It's not "in addition". It's main feature, explained above.
If you want to add additional information, let's put simple inside this section https://github.com/xnimorz/use-debounce/blob/master/README.md#simple-values-debouncing
useDebounce returns a tuple with 2 arguments: debounced value and setter.
| } | ||
| ``` | ||
|
|
||
| This is particularly useful when you don't need to track the immediate input value and only care about the debounced result. The debounced setter also provides additional methods like `cancel`, `isPending`, and `flush` for advanced control. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Added section on using the debounced setter with example.
Currently this is not documented and AI is complaining when using this because when looking at the documentation it does not see it anywhere