# stb-emitter

> STB SDK base events emitter implementation.

Latest version **1.3.3** (published 2015-10-12) · GPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install stb-emitter
pnpm add stb-emitter
yarn add stb-emitter
bun add stb-emitter
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.3 |
| Published | 2015-10-12 |
| First published | 2015-10-07 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Stanislav Kalashnik |
| Maintainers | darkpark |
| Keywords | stb, sdk, device, tv, devkit, framework, emitter |

## Links

- npm: https://www.npmjs.com/package/stb-emitter
- Repository: https://github.com/stbsdk/emitter
- Homepage: https://github.com/stbsdk/emitter#readme
- Issues: https://github.com/stbsdk/emitter/issues
- npm.io page: https://npm.io/package/stb-emitter

## Alternatives

- [async-exit-hook](https://npm.io/package/async-exit-hook.md) — 3.7M weekly downloads
- [evnty](https://npm.io/package/evnty.md) — 7.2K weekly downloads
- [eleventy-plugin-asciidoc](https://npm.io/package/eleventy-plugin-asciidoc.md) — 3.5K weekly downloads
- [@jswork/next-get2get](https://npm.io/package/@jswork/next-get2get.md) — 945 weekly downloads
- [@dashersw/axon](https://npm.io/package/@dashersw/axon.md) — 934 weekly downloads

## Recent versions

- 1.3.3 (latest) — 2015-10-12
- 1.3.2 — 2015-10-07
- 1.3.1 — 2015-10-07
- 1.3.0 — 2015-10-07

## README

STB SDK base events emitter implementation
==========================================

[![NPM version](https://img.shields.io/npm/v/stb-emitter.svg?style=flat-square)](https://www.npmjs.com/package/stb-emitter)
[![Dependencies Status](https://img.shields.io/david/stbsdk/emitter.svg?style=flat-square)](https://david-dm.org/stbsdk/emitter)
[![Gitter](https://img.shields.io/badge/gitter-join%20chat-blue.svg?style=flat-square)](https://gitter.im/DarkPark/stb)


Almost all components in STB SDK emit events: a [Model](https://github.com/stbsdk/model) emits an event each time an attribute is set, a [router](https://github.com/stbsdk/router) emits an event when a page is opened.
All components which emit events are instances of `Emitter`.

Typically, there aren't any 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

```bash
npm install stb-emitter
```


## Usage

Add the constructor to the scope:

```js
var Emitter = require('stb-emitter');
```

Create an instance:

```js
var emitter = new Emitter();
```

Add listeners for some events:

```js
emitter.addListener('click', function ( data ) { ... });
emitter.addListener('click', function ( data ) { ... });
```

Add listener that will be notified only one time:

```js
emitter.once('click', function ( data ) { ... });
```

Add multiple listeners at once:

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

Remove all instances of the given callback:

```js
emitter.removeListener('click', func1);
```

Remove all callbacks for the given event name:

```js
emitter.removeListener('click');
```

Clears all events:

```js
emitter.removeListener();
```

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

```js
emitter.emit('init');
emitter.emit('click', {src: panel1, dst: panel2});
```


## Performance notes

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

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


## Debug mode

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

In debug mode the constructor is exposed to the global namespace as `window.Emitter`.


## Contribution

If you have any problem or suggestion please open an issue [here](https://github.com/stbsdk/emitter/issues).
Pull requests are welcomed with respect to the [JavaScript Code Style](https://github.com/DarkPark/jscs).


## License

`stb-emitter` is released under the [GPL-3.0 License](http://opensource.org/licenses/GPL-3.0).

---
_Source: https://npm.io/package/stb-emitter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._