# cjs-emitter

> Basic events emitter implementation.

Latest version **1.5.3** (published 2018-08-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install cjs-emitter
pnpm add cjs-emitter
yarn add cjs-emitter
bun add cjs-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.5.3 |
| Published | 2018-08-04 |
| First published | 2015-12-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Stanislav Kalashnik |
| Maintainers | cjssdk, darkpark |
| Keywords | commonjs, cjs, sdk, cjssdk, framework, emitter |

## Links

- npm: https://www.npmjs.com/package/cjs-emitter
- Repository: https://github.com/cjssdk/emitter
- Homepage: https://github.com/cjssdk/emitter#readme
- Issues: https://github.com/cjssdk/emitter/issues
- npm.io page: https://npm.io/package/cjs-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.5.3 (latest) — 2018-08-04
- 1.5.1 — 2018-02-15
- 1.5.0 — 2016-10-19
- 1.4.1 — 2015-12-16

## README

Basic events emitter implementation
===================================

[![build status](https://img.shields.io/travis/cjssdk/emitter.svg?style=flat-square)](https://travis-ci.org/cjssdk/emitter)
[![npm version](https://img.shields.io/npm/v/cjs-emitter.svg?style=flat-square)](https://www.npmjs.com/package/cjs-emitter)
[![dependencies status](https://img.shields.io/david/cjssdk/emitter.svg?style=flat-square)](https://david-dm.org/cjssdk/emitter)
[![devDependencies status](https://img.shields.io/david/dev/cjssdk/emitter.svg?style=flat-square)](https://david-dm.org/cjssdk/emitter?type=dev)
[![Gitter](https://img.shields.io/badge/gitter-join%20chat-blue.svg?style=flat-square)](https://gitter.im/DarkPark/cjssdk)
[![RunKit](https://img.shields.io/badge/RunKit-try-yellow.svg?style=flat-square)](https://npm.runkit.com/cjs-emitter)


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 ##

```bash
npm install cjs-emitter
```


## Usage ##

Add the constructor to the scope:

```js
var Emitter = require('cjs-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});
emitter.emit('load', error, data);
```


## Performance notes ##

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

```js
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 problems or suggestions please open an [issue](https://github.com/cjssdk/emitter/issues)
according to the contribution [rules](.github/contributing.md).


## License ##

`cjs-emitter` is released under the [MIT License](license.md).

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