kontroll
kontroll ("control") is a tiny, dead-simple package for function behavior controls like debounce, countdown, throttle (limit).
Features
- 100% coverage!
- Self-explained: for real, every functions and options have TSDoc comments to explain their behavior plus examples at a hover (based on your IDE), apart from the already intuitive logic path.
- Clearable: you can stop pending timers by calling the returned clearer function or use the
clear(key)
function. - Promise aware: avoid duplicated call if your promise haven't settled.
Usage
Install package:
npm install kontroll
yarn add kontroll
pnpm install kontroll
Import:
import {
clear,
countdown,
debounce,
throttle,
} from 'kontroll'
const doSum = (...numbers) => console.log(numbers.reduce((acc, cur) => acc + cur, 0))
const makeDoSum = (...numbers) => () => doSum(numbers)
const clearCountdown = countdown(1000, makeDoSum(1, 2), { key: 'defined', replace: false })
const clearDebounce = debounce(1000, makeDoSum(3, 4), { key: 34, leading: false })
const resetThrottle = throttle(1000, makeDoSum(5, 6), { trailing: false })
Notice
key
behavior
Kontroll follows a key-first strategy, as long as things share the same key, they share the same timer.
If a options.key
is not present, key are taken as callback.toString()
.
If you call something like:
debounce(1000, () => console.log(variable))
debounce(1000, makeDoSum(1, 2))
debounce(1000, makeDoSum(2, 3))
multiple times,
The callback are properly debounced, because they have the same callback body.
But be noticed, for something like:
debounce(1000, () => console.log('hi'))
debounce(1000, () => console.log('hello'))
The automated key are different for the two calls (because they have different callback body), so they are timed separately.
In you wish them to have the same timer, you can manually set options.key
like: debounce(1000, () => {}, { key: 'KEY' })
License
MIT License © 2023 NamesMT