github / github/mini-throttle

The throttle is not performing as expected.

Open
#23 0 comments 4 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
229
Forks
18
Avg merge
1d 10h
Merged PRs (30d)
2

Description

The throttle of this library does not perform throttling (it behaves differently from what is described in the tests and documentation).

You will understand if you try the following reproduction code in [RunKit](https://npm.runkit.com/%40github%2Fmini-throttle). Instead of behaving like [the marble in the test cases](https://github.com/github/mini-throttle/blob/7fb6f52c98c735fe44f6096c8bddd051976d3ae0/test/index.ts#L167), it appears to perform a complete debounce operation, firing only once at the start and once at the end.

> | throttle(fn, 100) | 1 2 4 6 8 10 |

![image](https://github.com/github/mini-throttle/assets/7282145/454d4d46-014a-45ca-88ec-0ddcb03a7342)

```javascript
var {throttle} = require("@github/mini-throttle")

const delay = (m) => new Promise(r => setTimeout(r, m))

const fn = throttle((...x)=>{console.log(x)},1000)

for (let i = 1; i <= 10; ++i) {
fn(i)
await delay(100)
}
await delay(1000)
```

---

You can also repro this in the following CodeSandbox. Please rapidly click the button. While the expected throttle behavior is that of lodash.throttle, but mini-throttle does not perform as its name "throttle".

https://codesandbox.io/p/sandbox/damp-browser-fyd2g4?file=/src/index.js:24,11

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.