Security News
Cloudflare Adds Security.txt Setup Wizard
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
events-to-async
Advanced tools
Treat EventEmitter-like object using Async/Await, Async Iterator.
Treat EventEmitter-like object using Async/Await or Async Iterator.
Similar one of Node.js events.on
and event.once
, but it is generic.
events.on
and event.once
only
support events
Install with npm:
npm install events-to-async
once an event to Promise
import { EventEmitter } from "events";
import { on } from "events-to-async";
const events = new EventEmitter();
setTimeout(() => {
events.emit("change", 1);
});
const event = await once((handler) => events.once("change", handler));
console.log(event); // => [1]
on events to AsyncIterator
import { EventEmitter } from "events";
import { on } from "events-to-async";
const events = new EventEmitter();
const asyncIterator = on((handler) => {
event.on("change", handler); // Listen
return () => {
// This function is called on occuring error or `break;`
event.off("change", handler); // UnListen
}
});
setTimeout(() => {
events.emit("change", 1);
events.emit("change", 2);
events.emit("change", 3);
});
for await(const event of asyncIterator) {
console.log(event); // [1] → [2] → [3]
}
// Unreachable here
You can stop the async iterator by using break;
import { EventEmitter } from "events";
import { on } from "events-to-async";
const events = new EventEmitter();
const asyncIterator = on((handler) => {
events.on("change", handler); // Listen
return () => {
// This function is called on occuring error or `break;`
events.off("change", handler); // UnListen
}
});
setTimeout(() => {
events.emit("change", 1);
events.emit("change", 2);
events.emit("change", 3);
});
for await(const [num] of asyncIterator) {
console.log(num); // 1 → 2 → 3
if (num === 3) {
break;
}
}
console.log("4!!!");
You can cancel events using AbortController.
once an event with cancel
import { EventEmitter } from "events";
import { on } from "events-to-async";
const events = new EventEmitter();
const abortController = new AbortController();
const event = once((handler) => {
event.once("change", handler);
return () => {
event.off("change", handler); // call it when occur error or abort
}
}, { signal: abortController.signal });
// Abort
abortController.abort();
await event; // => throw Abort Error
on events with cancel
import { EventEmitter } from "events";
import { on } from "events-to-async";
const events = new EventEmitter();
const abortController = new AbortController();
const asyncIterator = on((handler) => {
events.on("change", handler);
return () => {
events.off("change", handler);
}
}, { signal: abortController.signal });
// Abort
abortController.abort();
on<T>
and once<T>
support generics that represent iterated value.
:memo: on<T>
and once<T>
always return an array
import { EventEmitter } from "events";
import { on } from "events-to-async";
const events = new EventEmitter();
type Event = number;
const asyncIterator = on<[Event]>((handler) => {
events.on("change", handler);
return () => events.off("change", handler)
});
setTimeout(() => {
events.emit("change", 1);
events.emit("change", 2);
events.emit("change", 3);
});
for await(const event of asyncIterator) {
console.log(event); // [1] → [2] → [3]
}
This library aim to support yet another events
module like eventmit.
import { eventmit } from "eventmit";
import { on } from "events-to-async";
type Event = { key: string };
const events = eventmit<Event>();
const asyncIterator = on<[Event]>((handler) => {
events.on(handler);
return () => events.off(handler);
});
setTimeout(() => {
events.emit({ key: "value" });
});
for await (const event of asyncIterator) {
assert.deepStrictEqual(event, [{ key: "value" }]);
break;
}
See Releases page.
Install devDependencies and Run npm test
:
npm test
Pull requests and stars are always welcome.
For bugs and feature requests, please create an issue.
git checkout -b my-new-feature
git commit -am 'Add some feature'
git push origin my-new-feature
MIT © azu
FAQs
Treat EventEmitter-like object using Async/Await, Async Iterator.
The npm package events-to-async receives a total of 1,731 weekly downloads. As such, events-to-async popularity was classified as popular.
We found that events-to-async demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.