Add maxWait option
#12
Conversation
index.d.ts
Outdated
| @@ -7,6 +7,15 @@ declare namespace debounceFn { | |||
| */ | |||
| readonly wait?: number; | |||
|
|
|||
| /** | |||
| Maximum time to wait until the `input` function is called. | |||
There was a problem hiding this comment.
It needs a clearer description of how it's different from wait.
There was a problem hiding this comment.
It would also be useful to include a use-case for this option (like you mention in the PR description).
There was a problem hiding this comment.
You also need to update the readme.
There was a problem hiding this comment.
Also, make it clear that "time" is in milliseconds.
There was a problem hiding this comment.
I have tried to improve this. I'm not sure the first line is any better, but I don't how to make it better
|
It's still not clear to the user how |
|
Ive tried again to reword it based on what lodash say |
readme.md
Outdated
| ##### maxWait | ||
|
|
||
| Type: `number`\ | ||
| Default: `0` (disabled) |
There was a problem hiding this comment.
Readme and index.d.ts should be in sync.
|
Thanks :) |
This adds a
maxWaitoption.The intention is to ensure that the callback is fired after at most maxWait of time.
This is particularly useful in the following situation. Perhaps this is streaming data of an volume control changing, but the source is sending updates too often.
wait=100, maxWait=1000
With the debounce being called every ~50ms for 30s.
Without this, only one update will be processed at the very end, rather than one every second.