component-emitter
Event emitter
Last updated 8 months ago by nami-doc .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install component-emitter 
SYNC missed versions from official npm registry.

Emitter Build Status

Event emitter component.

Installation

$ component install component/emitter

API

Emitter(obj)

The Emitter may also be used as a mixin. For example a "plain" object may become an emitter, or you may extend an existing prototype.

As an Emitter instance:

var Emitter = require('emitter');
var emitter = new Emitter;
emitter.emit('something');

As a mixin:

var Emitter = require('emitter');
var user = { name: 'tobi' };
Emitter(user);

user.emit('im a user');

As a prototype mixin:

var Emitter = require('emitter');
Emitter(User.prototype);

Emitter#on(event, fn)

Register an event handler fn.

Emitter#once(event, fn)

Register a single-shot event handler fn, removed immediately after it is invoked the first time.

Emitter#off(event, fn)

  • Pass event and fn to remove a listener.
  • Pass event to remove all listeners on that event.
  • Pass nothing to remove all listeners on all events.

Emitter#emit(event, ...)

Emit an event with variable option args.

Emitter#listeners(event)

Return an array of callbacks, or an empty array.

Emitter#hasListeners(event)

Check if this emitter has event handlers.

License

MIT

Current Tags

  • 1.3.0                                ...           latest (8 months ago)

5 Versions

  • 1.3.0                                ...           8 months ago
  • 1.2.1                                ...           4 years ago
  • 1.2.0                                ...           5 years ago
  • 1.1.3                                ...           5 years ago
  • 1.1.2                                ...           6 years ago
Downloads
Today 32,160
This Week 63,296
This Month 252,447
Last Day 31,136
Last Week 179,372
Last Month 768,894
Dependencies (0)
None
Dev Dependencies (2)
Dependents (605)

Copyright 2014 - 2017 © taobao.org |