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

generate-js-events

v3.0.0

Published

A generator for EventEmitter, lets you create an objects that can emit events.

Downloads

77

Readme

Generate-JS-Events

GitHub release npm version npm downloads npm downloads

Table of Contents

EventEmitter

A generator for EventEmitter, lets you create an objects that can emit events, or generate a new generator that inherits from EventEmitter.

Install:

$ npm install generate-js-events

new EventEmitter()

  • return: Object A new object that inherits from EventEmitter.

Creates a new object that inherits from EventEmitter.

Example:

var EventEmitter = require('generate-js-events');

var myEmitter = new EventEmitter();

EventEmitter.generate(create)

  • create Function Create method that gets called when creating a new object that inherits from EventEmitter.
  • return: Generator A new generator that inherits from EventEmitter.

Returns a new generator that inherits from EventEmitter.

Example:

var myGenerator = EventEmitter.generate(
	/* create method */
	function myGenerator() {
		// my create code here
	}
);

myGenerator.definePrototype(
	{
		// my descriptor here
	},
	{
		// my prototype here
	}
);

Class: Generation

A new generator that inherits from the generator that generated it using the EventEmitter.generate(create) method.

Class: Creation

A new object that inherits from the generator that created it using the new EventEmitter() method.

Creation.on(event, listener[, observer]

  • event String Name of event.
  • listener Function Event handler function.
  • observer Object Object reference for binding.
  • return: Object This object.

Adds a 'listener' on 'event' to this EventEmitter instance.

Example:

/*
 * Set lestener.
 * NOTE: myEmitter.off('error') does not remove *this* listener.
 */
myEmitter.onerror = function (err) {
	console.log(err);
}

/*
 * Add listener.
 */
myEmitter.on('myevent', function(a, b, c) {
	console.log(a, b, c);
});

Creation.once(event, listener[, observer])

  • event String Name of event.

  • listener Function Event handler function.

  • observer Object Object reference for binding.

  • return: Object This object.

Adds a 'listener' on 'event' to this EventEmitter instance which is removed after one 'event'.

Example:

/*
 * Add one-time listener.
 */
myEmitter.once('myobjectevent', function(event) {
	console.log(event);
});

Creation.off([event][, listener][, observer])

  • event String Name of event.
  • listener Function Event handler function.
  • observer Object Object reference for binding.
  • return: Object This object.

Removes a 'listener' on 'event', or all listeners on 'event', or all listeners from this EventEmitter instance.

Example:

/*
 * Remove specific listener.
 */
function specific(event) {
	console.log(event);
}

myEmitter.on('specific', specific);

myEmitter.off('specific', specific);

/*
 * Remove all listeners on same event.
 */
myEmitter.off('same');

/*
 * Remove All listeners.
 */
myEmitter.off();

Creation.emit(event, [...args])

  • event String Name of event.
  • args Arguments All other arguments to be emitted to listeners.
  • return: Object This object.

Emits an 'event' with 'args' on this EventEmitter instance.

Example:

/*
 * Emits 1, 2, 3 on 'myevent' listener(s).
 */
myEmitter.emit('myevent', 1, 2, 3);

Creation.emitEvent(event, eventObject)

  • event String Name of event.
  • eventObject Object An event object to be emitted to listeners.
  • return: Object This object.

Emits an event object containing 'eventObject' on this EventEmitter instance.

Example:

/*
 * Emits {eventData: 'data'} on 'myobjectevent' listener(s).
 */
myEmitter.emitEvent('myobjectevent', {eventData: 'data'});