streamich/react-use

useDebounce and cancellation

Open

#401 opened on Jun 18, 2019

View on GitHub
 (5 comments) (6 reactions) (0 assignees)TypeScript (43,979 stars) (3,273 forks)batch import
enhancementhelp wanted

Description

Similar to how debounce does it, the hook should return callbacks to clear and flush. This is important for scenarios, where some other action has immediate priority and debounce, should be silenced in that case. The typical is having debounced submit of form input but be able to just hit Enter to speed up the action.

Personally, I haven't used flush operation anywhere yet and cannot imagine some practical use case for it.

Contributor guide

Tech stack
typescriptreact
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
React hooksTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Investigate the existing useDebounce hook in the react use source code (likely in src/useDebounce.ts). Implement clear and flush callbacks similar to the debounce npm package. Ensure the hook returns an object with cancel and flush functions. Add appropriate TypeScript types and update the hook's tests.