effector-debounce v1.1.0

Effector Debounce

https://codesandbox.io/s/effector-throttle-debounce-w32tk

Installation

npm install --save effector effector-debounce

# or

yarn add effector effector-debounce

Usage

Create event that should be debounced:

import { createEvent } from 'effector';

const someHappened = createEvent<number>();

Create debounced event from it:

import { createDebounce } from 'effector-debounce';

const DEBOUNCE_TIMEOUT_IN_MS = 200;

const debounced = createDebounce(someHappened, DEBOUNCE_TIMEOUT_IN_MS);

To test that original event is correctly debounced you can add watcher:

someHappened.watch((payload) => {
  console.info('someHappened now', payload);
});

debounced(1);
debounced(2);
debounced(3);
debounced(4);

// someHappened now 4

Also you can use Effect and Store as trigger. createDebounce always returns Event:

const event = createEvent<number>();
const debouncedEvent: Event<number> = createDebounce(event, 100);

const fx = createEffect<number, void>();
const debouncedEffect: Event<number> = createDebounce(fx, 100);

const $store = createStore<number>(0);
const debouncedStore: Event<number> = createDebounce($store, 100);

Change name

const trigger = createEvent();
const debounced = createDebounce(trigger, 100);

// Now debounced var has `triggerDebounceTick` name

To change name:

const trigger = createEvent();
const debounced = createDebounce(trigger, 100, { name: 'Hello' });

// Now debounced var has `HelloDebounceTick` name