Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/loreanvictor/audit-debounce
Rxjs operator to debounce and audit simultaenously
https://github.com/loreanvictor/audit-debounce
Last synced: 7 days ago
JSON representation
Rxjs operator to debounce and audit simultaenously
- Host: GitHub
- URL: https://github.com/loreanvictor/audit-debounce
- Owner: loreanvictor
- License: mit
- Created: 2023-12-21T08:37:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-08T06:38:45.000Z (about 1 year ago)
- Last Synced: 2024-12-17T21:18:02.708Z (about 1 month ago)
- Language: TypeScript
- Size: 157 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-angular - audit-debounce - RxJS operator to debounce and audit simultaenously. (Table of contents / Third Party Components)
- fucking-awesome-angular - audit-debounce - RxJS operator to debounce and audit simultaenously. (Table of contents / Third Party Components)
README
[](https://bundlejs.com/?q=audit-debounce)
[](https://www.npmjs.com/package/audit-debounce)
[](https://github.com/loreanvictor/audit-debounce/actions/workflows/coverage.yml)
# audit-debounce
[RxJS](https://rxjs.dev) operator to debounce and audit simultaenously. When you [`debounce()`](https://rxjs.dev/api/operators/debounce) a particularly active observable, you might have to wait a long
time to get any value from it (if it is constantly emitting values). `auditDebounce()` solves this problem by
debouncing the observable, but also emitting the latest value after a given duration has passed.
```js
import { auditDebounceTime } from 'audit-debounce'
source$.pipe(
// debounce for 100ms, but also emit the latest value after 1000ms
auditDebounceTime(100, 1000)
)
```
```js
import { timer } from 'rxjs'
import { auditDebounce } from 'audit-debounce'
source$.pipe(
// debounce for 100ms, but also emit the latest value after 1000ms
auditDebounce(
() => timer(100),
() => timer(1000)
)
)
```
[▶ TRY IT](https://codepen.io/lorean_victor/pen/jOJqdNv?editors=0010)
# Contents
- [Contents](#contents)
- [Installation](#installation)
- [Usage](#usage)
- [Contribution](#contribution)
# Installation
[Node](https://nodejs.org/en/):
```bash
npm i audit-debounce
```
Browser / [Deno](https://deno.land):
```js
import { auditDebounceTime } from 'https://esm.sh/audit-debounce'
```
# Usage
This package provides the following functions:
```ts
function auditDebounceTime(
debounceTime: number,
auditTime: number,
scheduler?: SchedulerLike
): MonoTypeOperatorFunction
```
```ts
function auditDebounce(
debounceSelector: (value: T | typeof CANCEL_SIGNAL) => ObservableInput,
auditSelector: (value: T | typeof CANCEL_SIGNAL) => ObservableInput
): MonoTypeOperatorFunction
```
The operator will debounce incoming values, but also makes sure values are emitted after certain duration
is passed.
```
source$: --a-b------c-d-e-f------h-i-j-k-l----->
debounceSelector$: -----x ---------x -----------x
auditSelector$: -------y -------y -------y
result$: -------b----------f------------k---l-->
```
# Contribution
You need [node](https://nodejs.org/en/), [NPM](https://www.npmjs.com) to start and [git](https://git-scm.com) to start.
```bash
# clone the code
git clone [email protected]:loreanvictor/audit-debounce.git
```
```bash
# install stuff
npm i
```
Make sure all checks are successful on your PRs. This includes all tests passing, high code coverage, correct typings and abiding all [the linting rules](https://github.com/loreanvictor/audit-debounce/blob/main/.eslintrc). The code is typed with [TypeScript](https://www.typescriptlang.org), [Jest](https://jestjs.io) is used for testing and coverage reports, [ESLint](https://eslint.org) and [TypeScript ESLint](https://typescript-eslint.io) are used for linting. Subsequently, IDE integrations for TypeScript and ESLint would make your life much easier (for example, [VSCode](https://code.visualstudio.com) supports TypeScript out of the box and has [this nice ESLint plugin](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)), but you could also use the following commands:
```bash
# run tests
npm test
```
```bash
# check code coverage
npm run coverage
```
```bash
# run linter
npm run lint
```
```bash
# run type checker
npm run typecheck
```