@tbela99/observer

Event Observer

Manage custom events

Installation

$ npm i @tbela99/observer

Usage

NodeJS

import {Observer} from '@tbela99/observer';

const observer = new Observer();

// register change listener
observer.on('change', (...args) => console.log(...args));

// trigger change event
observer.trigger('change', 'a', 'b', 'c');

// trigger change event
observer.trigger('change', 'a', 'b', 'c');

// run all event handlers in return a promise
observer.triggerAsync('change', 'a', 'b', 'c').then(result => console.debug(result));

Web

<script src="./dist/index.js"></script>
<script>

    const observer = new Observer();

    // register change listener
    observer.on('change', (...args) => console.log(...args));

    // trigger change event
    observer.trigger('change', 'a', 'b', 'c');
</script>

Using AbortController

AbortController can be used to unregister and event handler

const controller = new AbortController();

observer.on('change', (...args) => console.log('something has changed', ...args), controller.signal);

observer.trigger('change', 'I have changed');

// remove event listener
controller.abort();

// the event handler is unregistered
observer.trigger('change', 'I have also changed');

console.log(observer.hasListeners()) // true
console.log(observer.hasListeners('change')) // true
console.log(observer.hasListeners('click')) // false
console.log(observer.getListeners()) // {change: []}
console.log(observer.getListeners('change')) // []

Utilities

Observer provides some built-in event utilities.

Once

execute an event handler once, then remove it

// register change listener
observer.on('change:once', (...args) => console.log(...args));

// event handler is executed, then removed
observer.trigger('change', 'a', 'b', 'c');

// nothing happen
observer.trigger('change', 'a', 'b', 'c');

Times

execute an event handler a certain number of time, after which it is removed

// register change listener
observer.on('change:times(2)', (...args) => console.log(...args));

// event handler is executed
observer.trigger('change', 'a', 'b', 'c');
// event handler is executed
observer.trigger('change', 'a', 'b', 'c');

// nothing happens
observer.trigger('change', 'a', 'b', 'c');

Throttle

creates a throttled handler

// register throttled change listener. It is executed only once in a period of 250ms
observer.on('change:throttle(250)', (...args) => console.log(...args));

// event handler is executed
observer.trigger('change', 'a', 'b', 'c');

// ignored
observer.trigger('change', 'a', 'b', 'c');

Debounce

creates a debounced handler

    // register debounced change listener
    observer.on('change:debounce(250)', (...args) => console.log(...args));

    // event handler is executed
    observer.trigger('change', 'a', 'b', 'c');
    
    // ignored
    observer.trigger('change', 'a', 'b', 'c');