developit/decko

@debounce is named improperly — should be @throttle

Open

#9 opened on Mar 29, 2017

View on GitHub
 (4 comments) (10 reactions) (0 assignees)JavaScript (34 forks)github user discovery
bugdiscussionhelp wanted

Repository metrics

Stars
 (1,037 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

In the docs its says:

To debounce means "call this at most once per N ms". All outward function calls get collated into a single inward call, and only the latest (most recent) arguments as passed on to the debounced function.

What you're doing is throttling, not debouncing. lodash.throttle:

Creates a throttled function that only invokes func at most once per every wait milliseconds.

lodash.debounce:

Creates a debounced function that delays invoking func until after wait milliseconds have elapsed since the last time the debounced function was invoked.

And while on the topic, a (real) @debounce would be a great addition.

Contributor guide

Research direction
Rename the @debounce decorator to @throttle in source code, tests, and documentation. Ensure the existing implementation correctly implements throttle. Optionally, implement a new @debounce decorator that delays invocation until after wait milliseconds have elapsed since the last invocation.
Tech stack
javascript
Domain
frontend
Issue type
Bug
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.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
JavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75