- Class:EventIterable
- [EventIterable.wrap( eventEmitter, eventNames[, signal ] )](#eventiterablewrap-eventemitter-eventnames-signal)
- eventIterable.stop()

Class:EventIterable

``javascript
const { EventIterable } = require( "eventIterable" );
`
`javascript
import { EventIterable } from "eventIterable";
`

EventIterable is a wrapper for EventEmitter, creating an AsyncIterable of the requested events which the user can, in an async context, iterate through using a for await ... of statement. When being iterated over, EventIterable produces objects of type: { eventName:string|symbol, value:any } where eventName is one of the eventNames provided in the wrap function.

EventIterable.wrap( eventEmitter, eventNames[, signal ] )

`javascript
const { EventEmitter } = require( "events" );

const { AbortController } = require( "node-abort-controller" );

const { EventIterable } = require( "event-iterable" );

class TimerEventEmitter extends EventEmitter {

#tick = false;
#timeout = undefined;

constructor() {
super();
this.ticktock();
}

ticktock() {
this.#tick = !this.#tick;
this.emit( this.#tick?"tick":"tock", new Date() );
this.#timeout = setTimeout( this.ticktock.bind( this ), Math.random()*2000 );
}

stop() {
clearTimeout( this.#timeout );
}
}

( async function main():Promise {
const eventEmitter = new TimerEventEmitter();
// eventEmitter.on( "tick", console.log );
// eventEmitter.on( "tock", console.log );

// After 10 seconds, we'll abort using the Abort Controller
const abortController = new AbortController();
setTimeout( () => abortController.abort(), 10000 );

const iterable = EventIterable.wrap( eventEmitter, ["tick", "tock"], abortController.signal );
for await ( const event of iterable ) {
console.log( event );
}
eventEmitter.stop();
} )();
``