https://github.com/scottcorgan/tiny-emitter

A tiny (less than 1k) event emitter library
https://github.com/scottcorgan/tiny-emitter

event-emitter tiny

Last synced: 10 days ago
JSON representation

A tiny (less than 1k) event emitter library

• Host: GitHub
• URL: https://github.com/scottcorgan/tiny-emitter
• Owner: scottcorgan
• License: mit
• Created: 2014-01-03T22:42:04.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2021-08-11T00:53:02.000Z (about 3 years ago)
• Last Synced: 2024-10-06T15:48:50.005Z (about 1 month ago)
• Topics: event-emitter, tiny
• Language: JavaScript
• Homepage:
• Size: 90.8 KB
• Stars: 934
• Watchers: 17
• Forks: 67
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-nodejs - tiny-emitter - A tiny (less than 1k) event emitter library.  (Repository / Event)
• awesome-list - tiny-emitter

README

        
# tiny-emitter

A tiny (less than 1k) event emitter library.

## Install

### npm

```

npm install tiny-emitter --save

```

## Usage

```js

var Emitter = require('tiny-emitter');

var emitter = new Emitter();

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

 //

});

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

```

Alternatively, you can skip the initialization step by requiring `tiny-emitter/instance` instead. This pulls in an already initialized emitter.

```js

var emitter = require('tiny-emitter/instance');

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

 //

});

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

```

## Instance Methods

### on(event, callback[, context])

Subscribe to an event

* `event` - the name of the event to subscribe to

* `callback` - the function to call when event is emitted

* `context` - (OPTIONAL) - the context to bind the event callback to

### once(event, callback[, context])

Subscribe to an event only **once**

* `event` - the name of the event to subscribe to

* `callback` - the function to call when event is emitted

* `context` - (OPTIONAL) - the context to bind the event callback to

### off(event[, callback])

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

* `event` - the name of the event to unsubscribe from

* `callback` - 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

## Test and Build

Build (Tests, Browserifies, and minifies)

```

npm install

npm run build

```

Test

```

npm install

npm test

```

## License

[MIT](https://github.com/scottcorgan/tiny-emitter/blob/master/LICENSE)