Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vicary/debounce-microtask
A TypeScript implementation of debounce with microtasks instead of timeout.
https://github.com/vicary/debounce-microtask
Last synced: 3 months ago
JSON representation
A TypeScript implementation of debounce with microtasks instead of timeout.
- Host: GitHub
- URL: https://github.com/vicary/debounce-microtask
- Owner: vicary
- License: mit
- Created: 2024-05-08T03:20:30.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-08-20T10:22:27.000Z (5 months ago)
- Last Synced: 2024-09-21T15:47:46.340Z (4 months ago)
- Language: TypeScript
- Size: 28.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# DebounceMicrotask
Debounce a function using microtasks instead of timers.
## Usage
```typescript
import { debounceMicrotask } from "@vicary/debounce-microtask";
const debounced = debounceMicrotask((text: string) => {
console.log("debounced", text);
});
debounced("a");
debounced("b");
debounced("c");
await Promise.resolve();
// Prints "debounced a"
```
### Options
#### debounceLimit
Throws when the specified limit is reached before the function is run, this is a
safety measure preventing recursive debounces. You may disable it with
`Infinity`.
Defaults to 1000.
```typescript
import { debounceMicrotask } from "@vicary/debounce-microtask";
const debounced = debounceMicrotask(
(text: string) => {
console.log("debounced", text);
},
{ debounceLimit: 1 },
);
debounced("a");
debounced("b"); // Throws
```
### limitAction
Specifies the action to take when the debounce limit is reached.
Possible values are `throw`, `ignore`, and `invoke`.
Defaults to `throw`.
```typescript
import { debounceMicrotask } from "@vicary/debounce-microtask";
const debounced = debounceMicrotask(
(text: string) => {
console.log("debounced", text);
},
{ limitAction: "throw" },
);
debounced("a");
debounced("b"); // Throws
```
### updateArguments
Updates the calling arguments to the latest invocation.
Defaults to `false`.
```typescript
import { debounceMicrotask } from "@vicary/debounce-microtask";
const debounced = debounceMicrotask(
(text: string) => {
console.log("debounced", text);
},
{ updateArguments: true },
);
debounced("a");
debounced("b");
debounced("c");
await Promise.resolve();
// Prints "debounced c"
```
### promise
Returns a promisified debounce function, the promise resolves when the specified
function is called.
```typescript
import { debounceMicrotask } from "@vicary/debounce-microtask/promise";
const debounced = debounceMicrotask(
(text: string) => {
console.log("debounced", text);
},
{
updateArguments: true,
},
);
await Promise.all([
debounced("a"),
debounced("b"),
debounced("c"),
]);
// Only prints "debounced c"
```
## Contributing
If you find a bug or would like to suggest a new feature, please open an issue
or submit a pull request on GitHub.
## License
DebounceMicrotask is licensed under the MIT License. See the LICENSE file for
more information.
## Funding
If you find this project useful, please consider supporting it by donating to
the author.
[](https://github.com/sponsors/vicary)