Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@cjssdk/emitter

Package Overview
Dependencies
Maintainers
1
Versions
2
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@cjssdk/emitter

Basic events emitter implementation.

  • 1.5.2
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
2
Maintainers
1
Weekly downloads
 
Created
Source

Basic events emitter implementation

build status npm version dependencies status devDependencies status Gitter RunKit

Typically, there are no strict restrictions on event names, as any string will be accepted. Usually it's a lowercase string with no spaces. Possible values: click, move, focus:item.

Functions can then be attached to objects, to be executed when an event is emitted. These functions are called listeners. Inside a listener function, this refers to the Emitter that the listener was attached to.

Installation

npm install @cjssdk/emitter

Usage

Add the constructor to the scope:

var Emitter = require('@cjssdk/emitter');

Create an instance:

var emitter = new Emitter();

Add listeners for some events:

emitter.addListener('click', function ( data ) { /* ... */ });
emitter.addListener('click', function ( data ) { /* ... */ });

Add listener that will be notified only one time:

emitter.once('click', function ( data ) { /* ... */ });

Add multiple listeners at once:

emitter.addListeners({
    click: function ( data ) {},
    close: function ( data ) {}
});

Remove all instances of the given callback:

emitter.removeListener('click', func1);

Remove all callbacks for the given event name:

emitter.removeListener('click');

Clears all events:

emitter.removeListener();

Execute each of the listeners in the given order with the supplied arguments:

emitter.emit('init');
emitter.emit('click', {src: panel1, dst: panel2});
emitter.emit('load', error, data);

Performance notes

It's a good idea to emit events only when there are some listeners:

if ( emitter.events['click'] ) {
    // notify listeners
    emitter.emit('click', {event: event});
}

Development mode

There is a global var DEVELOP which activates additional consistency checks and protection logic not available in release mode.

Contribution

If you have any problems or suggestions please open an issue according to the contribution rules.

License

@cjssdk/emitter is released under the MIT License.

Keywords

FAQs

Package last updated on 19 Apr 2018

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc