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

medooze-event-emitter

v1.2.1

Published

type-safe, modified version of EventEmitter

Downloads

459

Readme

medooze-event-emitter

This is a modified version of Node.js EventEmitter class for use within Medooze's codebase.

It's exported directly by this module, and meant to be extended rather than used as a standalone object.

The changes are:

  • the event definitions are type checked (see below)
  • emit() is marked protected to prevent it from accidentally being called from outside of the class
  • only a small subset of the API is exported (we can expand it if needed)
  • the maxListener limit is removed
  • implements an additional stop() method, which removes all listeners and causes future calls (except emit()) to be no-ops
  • exceptions thrown from event handlers are prevented from propagating out of emit() (thrown at the next tick instead)

Use with type checking

Using the same mechanism as tiny-typed-emitter, this class allows users to declare the events that a class may emit, as well as the arguments each one accepts. Calls to on() / once() / emit() are then typechecked accordingly.

Usage is as follows: projects that use type checking must supply an interface as generic parameter to the class when extending it. Each property of this interface is an event, and its type must be that of the listener (a function accepting some arguments and returning void).

Here's an example of how that would look in a project that uses JSDoc annotations (see tiny-typed-emitter for an example using TypeScript syntax):

const Emitter = require("medooze-event-emitter");

/**
 * @typedef {Object} SubscriptionEvents
 * @property {(transport: Transport, kind: boolean) => void} inited - subscription has initialized
 * @property {() => void} stopped - subscription has stopped
 */

/** @extends {Emitter<SubscriptionEvents>} */
class Subscription extends Emitter {
    // ...
}

Here we define a Subscription class that may emit two events: stopped, with no arguments, and inited with an argument of type Transport and another of type boolean.