Package Exports

serial-await-event-emitter
serial-await-event-emitter/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (serial-await-event-emitter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

serial-await-event-emitter

Replicate node EventEmitter, but with await for each listener.

Installation

npm i serial-await-event-emitter

Usage

import { SerialAwaitEventEmitter } from 'serial-await-event-emitter';

const emitter = new SerialAwaitEventEmitter()
const test = () =>
  new Promise((resolve) => {
    setTimeout(() => {
      console.log('test')
      resolve()
    }, 1000)
  })

emitter.on('event', async () => {
  // will wait 1000ms, then log
  await test()
})

async function run() {
  // emit is now run with await
  await emitter.emit('event', '...arguments')
  await emitter.emit('event', 'again')

  // also supports the classic sync method
  emitter.emitSync('event', 'again')
}

run()

One novelty feature is that adding, or prepending events while running is supported

// example-prepend.ts
import { SerialAwaitEventEmitter } from 'serial-await-event-emitter';

const emitter = new SerialAwaitEventEmitter()

emitter.on('aa', function initial() {});
emitter.prependOnce('aa', function once() { emitter.prepend('aa', function prepended() {})});
emitter.on('aa', function add() { emitter.once('aa', function addedOnce() {})});
emitter.on('aa', function final() {});

await emitter.emit('aa');
// will run: once, prepended, initial, add, final, addedOnce

emitter.listeners('aa');
// [prepended, initial, add, final]
// once listeners are removed after running

await emitter.emit('aa');
// this time will run: prepended, initial, add, final, addedOnce
// add method adds addedOnce each time is run
// BE AWARE. prepending using `on` will result in an infinite listeners being added, and an infinite loop for emit.

// example-remove.ts
import { SerialAwaitEventEmitter } from 'serial-await-event-emitter';

const emitter = new SerialAwaitEventEmitter()
const test1 = () => {};
const test2 = () => {};

emitter.on('bb', test1);
emitter.on('bb', () => {emitter.off('bb', test2)});
emitter.on('bb', test2);

await emitter.emit('bb');
// will run: test1, annonymous

emitter.listeners('bb');
// [test1, annonymous]

License

MIT