for-emit-of

for-emit-of

Turn Node.js Events into Async Iterables.

$ npm install for-emit-of

Example

import forEmitOf from 'for-emit-of';
import { Emitter } from '..'; // Example

const iterator = forEmitOf(Emitter, {
    event: "data", // Default
});

for await (const event of iterator){
    // Do Something 
}

Equivalent to

Emitter.on("data", () => {});

Transform

import forEmitOf from 'for-emit-of';
import { Emitter } from '..';

const iterator = forEmitOf(Emitter, {
    transform: async (event) => { // async aware
        return JSON.stringify(event);
    }
});

for await (const event of iterator){
    // Stringy
}

Equivalent to

Emitter.on("data", (event) => {
    const stringy = JSON.stringify(event);
});

Change the event

import forEmitOf from 'for-emit-of';
import { Cart } from '..';

const iterator = forEmitOf(Cart, {
    event: "checkout"
});

for await (const order of iterator){
    // Do Something 
}

Equivalent to

Cart.on("checkout", (order) => { ... });

FAQ

When will the iterator end?

Emitter.on("end") or Emitter.on("close")