Nomming Peanut M&M's

    @sapphire/event-iterator
    TypeScript icon, indicating that this package has built-in type declarations

    1.6.1 • Public • Published

    Sapphire Logo

    @sapphire/event-iterator

    Turns event emitter events into async iterators.

    GitHub codecov npm bundle size npm

    Table of Contents

    Description

    There is often a need to have async iterators with fine control, timeouts, limits, filter, and so on, this package exists to satisfy those needs. By implementing an async iterator which can be used with for await...of loops.

    Features

    • Written in TypeScript
    • Bundled with esbuild so it can be used in NodeJS and browsers
    • Offers CommonJS, ESM and UMD bundles
    • Fully tested

    Installation

    You can use the following command to install this package, or replace npm install with your package manager of choice.

    npm install @sapphire/event-iterator

    Usage

    Note: While this section uses require, the imports match 1:1 with ESM imports. For example const { EventIterator } = require('@sapphire/event-iterator') equals import { EventIterator } from '@sapphire/event-iterator'.

    Basic Usage

    // Import the EventIterator class
    const { EventIterator } = require('@sapphire/event-iterator');
    
    // Define an event iterator with a limit of 2 entries
    const iterator = new EventIterator(emitter, 'message', { limit: 2 });
    
    emitter.emit('message', { id: 'foo' });
    emitter.emit('message', { id: 'bar' });
    emitter.emit('message', { id: 'baz' });
    
    for await (const message of iterator) {
    	console.log(message);
    	// Logs: { id: 'foo' }
    	// Logs: { id: 'bar' }
    }
    
    // The iterator ended at second item, { id: 'baz' } is not collected due to the specified limit.

    Buy us some doughnuts

    Sapphire Community is and always will be open source, even if we don't get donations. That being said, we know there are amazing people who may still want to donate just to show their appreciation. Thank you very much in advance!

    We accept donations through Open Collective, Ko-fi, PayPal, Patreon and GitHub Sponsorships. You can use the buttons below to donate through your method of choice.

    Donate With Address
    Open Collective Click Here
    Ko-fi Click Here
    Patreon Click Here
    PayPal Click Here

    Contributors

    Thanks goes to these wonderful people (emoji key):


    Jeroen Claassens

    💻 🚇 📆 📖 ⚠️

    Antonio Román

    💻 📆 👀 ⚠️

    Gryffon Bellish

    💻 👀 ⚠️

    Vlad Frangu

    💻 🐛 👀 📓 ⚠️

    Stitch07

    💻 📆 ⚠️

    depfu[bot]

    🚧

    allcontributors[bot]

    📖

    Tyler J Russell

    📖

    Ivan Lieder

    💻 🐛

    Hezekiah Hendry

    💻

    Vetlix

    💻

    Ethan Mitchell

    📖

    Elliot

    💻

    Jurien Hamaker

    💻

    Charalampos Fanoulis

    📖

    dependabot[bot]

    🚧

    Kaname

    💻

    nandhagk

    🐛

    megatank58

    💻

    UndiedGamer

    💻

    Lioness100

    📖 💻

    David

    💻

    renovate[bot]

    🚧

    WhiteSource Renovate

    🚧

    FC

    💻

    Jérémy de Saint Denis

    💻

    MrCube

    💻

    bitomic

    💻

    c43721

    💻

    This project follows the all-contributors specification. Contributions of any kind welcome!

    Install

    npm i @sapphire/event-iterator

    DownloadsWeekly Downloads

    469

    Version

    1.6.1

    License

    MIT

    Unpacked Size

    43.9 kB

    Total Files

    8

    Last publish

    Collaborators

    • favna
    • kyranet
    • vladfrangu