Code Monkey home page Code Monkey logo

emitter's Introduction

Basic events emitter implementation

build status npm version dependencies status devDependencies status Gitter RunKit API

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 cjs-emitter

Usage

Add the constructor to the scope:

var Emitter = require('cjs-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 problem or suggestion please open an issue here. Pull requests are welcomed with respect to the JavaScript Code Style.

License

cjs-emitter is released under the MIT License.

emitter's People

Contributors

darkpark avatar rfbkak37y3kiy avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.