event-as-promise

event-as-promise

Handle continuous stream of events with Promise and generator function.

Instead of listen to event just once, event-as-promise chose an approach to allow listening to the same event continuously. And we support generator function to enable for await (const data of eventAsPromise) loop to handle event indefinitely.

Breaking changes

2.0.0

We moved default imports to named imports:

- import EventAsPromise from 'event-as-promise';
+ import { EventAsPromise } from 'event-as-promise';

We removed options: { array: boolean }, to receive all arguments from Node.js event emitter:

- target.on(eventAsPromise.eventListener);
+ target.on((...args) => eventAsPromise.eventListener(args));

Only eventListener is bound to the instance of EventAsPromise. Other functions (one and upcoming) are not bound and will need to be call in the context of EventAsPromise. If you want to call it bound:

  const eventAsPromise = new EventAsPromise();
- const one = eventAsPromise.one;
+ const one = eventAsPromise.one.bind(eventAsPromise)

  button.addEventListener('click', eventAsPromise.eventListener);

  await one();

How to use

Web server

This sample code is converted from Node about page.

import { EventAsPromise } from 'event-as-promise';
import http from 'http';

async function main(ready) {
  const server = http.createServer();
  const listeningPromises = new EventAsPromise();
  const requestPromises = new EventAsPromise();

  server
    .once('listening', listeningPromises.eventListener)
    .on('request', (...args) => requestPromises.eventListener(args))
    .listen(3000);

  // Wait for "listening"
  await listeningPromises.one();

  // Loop indefinitely, using generator
  for (let requestPromise of requestPromises) {
    // Wait for "request"
    const [req, res] = await requestPromise;

    res.statusCode = 200;
    res.setHeader('Content-Type', 'text/plain');
    res.end('Hello World\n');
  }
}

main();

Redux Saga

Handling event in a Promise may not reduce complexity. But it will be beneficial for redux-saga when mixed with call effect.

In this example, when the user is connected via CONNECTED action, we will keep the user posted about file changes, until a DISCONNECTED is received.

saga.run(function* () {
  yield takeLatest('CONNECTED', function* (action) {
    const watcher = fs.watch(action.payload);
    const changePromises = new EventAsPromise();

    watcher.on('change', changePromises.eventListener);

    for (;;) {
      const changes = yield race([
        call(changePromises.one),
        take('DISCONNECTED'),
      ]);

      if (changes) {
        yield put({ type: 'CHANGED', payload: changes });
      } else {
        break;
      }
    }

    watcher.close();
  });
});

Futures

You can retrieve multiple Promise objects before the event is emitted.

const emitter = new EventEmitter();
const countPromises = new EventAsPromise();

emitter.on('count', countPromises.eventListener);

// Retrieve multiple future Promise before the actual event is fired
const promise1 = countPromises.one();
const promise2 = countPromises.one();
const promise3 = countPromises.one();

emitter.emit('count', 1);
emitter.emit('count', 2);
emitter.emit('count', 3);

await expect(promise1).resolves.toBe(1);
await expect(promise2).resolves.toBe(2);
await expect(promise3).resolves.toBe(3);

Same as event listener, if one() is not called before the event is emitted, the event will be lost.

Upcomings

Instead of futures, you can use upcoming() to get the Promise for the upcoming event. Futures and upcoming Promises are independent of each other, as shown in the sample below.

const emitter = new EventEmitter();
const countPromises = new EventAsPromise();

emitter.on('count', countPromises.eventListener);

const promiseOne1 = countPromises.upcoming();
const promiseOne2 = countPromises.upcoming();
const promiseOne3 = countPromises.one();
const promiseTwo = countPromises.one();

emitter.emit('count', 'one');
emitter.emit('count', 'two');

await expect(promiseOne1).resolves.toBe('one');
await expect(promiseOne2).resolves.toBe('one');
await expect(promiseOne3).resolves.toBe('one');
await expect(promiseTwo).resolves.toBe('two');

const promiseThree = countPromises.upcoming();

emitter.emit('count', 'three');

await expect(promiseOne1).resolves.toBe('one');
await expect(promiseThree).resolves.toBe('three');

Note: after the current upcoming() has resolved, you will need to call upcoming() again to obtain a new Promise for the next upcoming event.

Contributions

Like us? Star us.

Want to make it better? File us an issue.

Don't like something you see? Submit a pull request.

Changelog

[2.0.0] - 2024-06-02

Changed

• Moved to new scaffold, added CJS/ESM exports
• Moved default imports to named imports
  • import { EventAsPromise } from 'event-as-promise'
• Removed options: { array: boolean }, to receive all arguments from Node.js event emitter
  • target.on((...args) => eventAsPromise.eventListener(args))
• Integration tests ported to mocha for better test conclusiveness, in PR #33
• Bumped dependencies, in PR #34
  • Development dependencies
    • @babel/preset-env@7.24.7
    • @babel/preset-typescript@7.24.7
    • @types/node@20.14.9
    • esbuild@0.21.5
    • prettier@3.3.2
    • tsup@8.1.0
    • typescript@5.5.2