npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@carry0987/event-emitter

v1.4.8

Published

EventEmitter is a TypeScript library that provides a simple yet powerful event-handling mechanism. It allows you to define and manage events in your application.

Downloads

119

Readme

EventEmitter-JS

NPM CI
EventEmitter is a TypeScript library that provides a simple yet powerful event-handling mechanism. It allows you to define and manage events in your application, supporting standard event operations such as on, off, emit, once, and more.

Features

  • Lightweight and easy to use
  • Type-safe event handling
  • Support for one-time event listeners with once
  • Flexible event management
  • Support for both synchronous and asynchronous event listeners

Installation

To install the EventEmitter library, use the following command:

npm i @carry0987/event-emitter -D

Usage

Importing the Library

First, import the EventEmitter class into your TypeScript file:

import { EventEmitter } from '@carry0987/event-emitter';

Defining Event Types

Define your event types for type safety. For example:

interface MyEvents {
    greet: [string];
    farewell: [string];
}

Creating an EventEmitter Instance

Create an instance of EventEmitter with your event types:

const emitter = new EventEmitter<MyEvents>();

Adding Event Listeners

Use the on method to add event listeners:

emitter.on('greet', (message) => {
    console.log(message);
});

Emitting Events

Emit events using the emit method:

emitter.emit('greet', 'Hello, world!');

Removing Event Listeners

Remove event listeners with the off method:

const greetListener = (message: string) => {
    console.log(message);
};

emitter.on('greet', greetListener);
emitter.off('greet', greetListener);

One-time Event Listeners

Use the once method to add a listener that will be called only once:

emitter.once('farewell', (message) => {
    console.log(message);
});

emitter.emit('farewell', 'Goodbye, world!'); // Listener will be called
emitter.emit('farewell', 'Goodbye again!');  // Listener will not be called

Using Asynchronous Event Listeners

Add asynchronous event listeners using the on or once method:

emitter.on('greet', async (message) => {
    await new Promise(resolve => setTimeout(resolve, 1000));
    console.log(`Async Listener: ${message}`);
});

emitter.emit('greet', 'Hello, async world!').then(() => {
    console.log('All async listeners have been called.');
});

API

on(event: EventName, listener: (...args: any[]) => void | Promise<void>): EventEmitter

Registers an event listener for the specified event.

off(event: EventName, listener: (...args: any[]) => void | Promise<void>): EventEmitter

Removes the specified event listener.

emit(event: EventName, ...args: any[]): Promise<boolean>

Emits the specified event, calling all registered listeners with the provided arguments. Returns a promise that resolves to true if there were listeners, and false otherwise.

once(event: EventName, listener: (...args: any[]) => void | Promise<void>): EventEmitter

Registers a one-time event listener for the specified event. The listener will be called at most once after being added.

listeners(): { [event: string]: ((...args: any[]) => void | Promise<void>)[] }

Returns an object containing all registered event listeners.

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

License

This project is licensed under the MIT License. See the LICENSE file for details.