loreanvictor/audit-debounce

Rxjs operator to debounce and audit simultaenously

audit-debounce

RxJS operator to debounce and audit simultaenously. When you 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.

import { auditDebounceTime } from 'audit-debounce'

source$.pipe(
  // debounce for 100ms, but also emit the latest value after 1000ms
  auditDebounceTime(100, 1000)
)

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

Contents

• Contents
• Installation
• Usage
• Contribution

Installation

Node:

npm i audit-debounce

Browser / Deno:

import { auditDebounceTime } from 'https://esm.sh/audit-debounce'

Usage

This package provides the following functions:

function auditDebounceTime<T>(
  debounceTime: number,
  auditTime: number,
  scheduler?: SchedulerLike
): MonoTypeOperatorFunction<T>

function auditDebounce<T>(
  debounceSelector: (value: T | typeof CANCEL_SIGNAL) => ObservableInput<any>,
  auditSelector: (value: T | typeof CANCEL_SIGNAL) => ObservableInput<any>
): MonoTypeOperatorFunction<T>

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, NPM to start and git to start.

# clone the code
git clone git@github.com:loreanvictor/audit-debounce.git

# 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. The code is typed with TypeScript, Jest is used for testing and coverage reports, ESLint and TypeScript ESLint are used for linting. Subsequently, IDE integrations for TypeScript and ESLint would make your life much easier (for example, VSCode supports TypeScript out of the box and has this nice ESLint plugin), but you could also use the following commands:

# run tests
npm test

# check code coverage
npm run coverage

# run linter
npm run lint

# run type checker
npm run typecheck