@1k/emitter

A tiny event emitter

Usage no npm install needed!

<script type="module">
  import 1kEmitter from 'https://cdn.skypack.dev/@1k/emitter';
</script>

README

@1k/emitter

A tiny (less than 1k) event emitter.

Install

npm

npm install @1k/emitter --save

Usage

var Emitter = require('@1k/emitter');
var emitter = new Emitter();

emitter.on('some-event', function (arg1, arg2, arg3) {
 //
});

emitter.emit('some-event', 'arg1 value', 'arg2 value', 'arg3 value');

Instance Methods

on(event, cb[, ctx])

Subscribe to an event

  • event - the name of the event to subscribe to
  • cb - the function to call when event is emitted
  • ctx - (OPTIONAL) - the context to bind the event cb to

once(event, cb[, ctx])

Subscribe to an event only once

  • event - the name of the event to subscribe to
  • cb - the function to call when event is emitted
  • ctx - (optional) - the context to bind the event cb to

off(event[, cb])

Unsubscribe from an event or all events. If no cb is provided, it unsubscribes you from all events.

  • event - the name of the event to unsubscribe from
  • cb - the function used when binding to the event

emit(event[, arguments...])

Trigger a named event

  • event - the event name to emit
  • arguments... - any number of arguments to pass to the event subscribers

License

MIT