Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rocket-connect/for-emit-of
Turn Node.js Events into Async Iterables.
https://github.com/rocket-connect/for-emit-of
async emitter events generator iterator streams
Last synced: about 1 month ago
JSON representation
Turn Node.js Events into Async Iterables.
- Host: GitHub
- URL: https://github.com/rocket-connect/for-emit-of
- Owner: rocket-connect
- License: mit
- Created: 2020-04-13T07:18:49.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T11:56:28.000Z (almost 2 years ago)
- Last Synced: 2024-12-07T12:43:55.857Z (about 2 months ago)
- Topics: async, emitter, events, generator, iterator, streams
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/for-emit-of
- Size: 2.64 MB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# for-emit-of
 [](https://www.npmjs.com/package/for-emit-of) [](https://github.com/danstarns/for-emit-of)
Turn Node.js Events into Async Iterables.
```
$ npm install for-emit-of
```
- [Example](#example)
- [Transform](#transform)
- [Change the event](#change-the-event)
- [Change the end](#change-the-end)
- [Timeout](#timeout)
- [`firstEventTimeout`](#firsteventtimeout)
- [`inBetweenTimeout`](#inbetweentimeout)
- [Limit](#limit)
- [Debug](#debug)
- [Keep Alive](#keep-alive)
# Example
```javascript
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
```javascript
Emitter.on("data", () => {});
```
# Transform
```javascript
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
```javascript
Emitter.on("data", (event) => {
const stringy = JSON.stringify(event);
});
```
# Change the event
```javascript
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
```javascript
Cart.on("checkout", (order) => { ... });
```
# Change the end
```javascript
import forEmitOf from 'for-emit-of';
import { Cart } from '..';
const iterator = forEmitOf(Cart, {
end: ["end", "close"] // default
});
```
# Timeout
## `firstEventTimeout`
```javascript
import forEmitOf from 'for-emit-of';
import { EventEmitter } from "events";
const emitter = new EventEmitter();
const iterator = forEmitOf(emitter, {
firstEventTimeout: 1000,
});
setTimeout(() => {
emitter.emit("data", {});
}, 2000); // greater than firstEventTimeout ERROR!
for await (const msg of iterator) {
console.log(msg); // never get here
}
```
## `inBetweenTimeout`
```javascript
import forEmitOf from 'for-emit-of';
import { EventEmitter } from "events";
const emitter = new EventEmitter();
const iterator = forEmitOf(emitter, {
inBetweenTimeout: 1000,
});
setInterval(() => {
emitter.emit("data", {})
}, 2000) // greater than inBetweenTimeout ERROR!
for await (const msg of iterator) {
console.log(msg); // gets here once
}
```
# Limit
```js
import forEmitOf from 'for-emit-of';
import { EventEmitter } from "events";
const emitter = new EventEmitter();
const iterator = forEmitOf(emitter, {
limit: 10
});
const interval = setInterval(() => {
emitter.emit("data", {});
}, 100);
let msgCount = 0;
for await (const msg of iterator) {
msgCount += 1
}
clearInterval(interval);
console.log(msgCount); // 10
```
# Debug
```ts
import forEmitOf from 'for-emit-of';
import { EventEmitter } from "events";
const emitter = new EventEmitter();
const iterator = forEmitOf(emitter, {
limit: 10,
debug: true // logs
});
```
# Keep Alive
```ts
import forEmitOf from 'for-emit-of';
import { EventEmitter } from "events";
const neverEmit = new EventEmitter();
const iterator = forEmitOf(neverEmit, {
keepAlive: 1000
});
for await (const data of iterator){
// waiting ⌛
}
```