# events-es5

> Custom events dispatcher (listener) for browsers and node.js.

Latest version **1.1.6** (published 2016-07-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install events-es5
pnpm add events-es5
yarn add events-es5
bun add events-es5
```

## 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.1.6 |
| Published | 2016-07-17 |
| First published | 2016-06-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Wenwu Wu |
| Maintainers | wenwu |
| Keywords | events, dispatcher, listener, event, emitter, observer, pubsub, subscriber |

## Links

- npm: https://www.npmjs.com/package/events-es5
- Repository: https://github.com/wenwuwu/events-es5
- Homepage: https://github.com/wenwuwu/events-es5#readme
- Issues: https://github.com/wenwuwu/events-es5/issues
- npm.io page: https://npm.io/package/events-es5

## 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.1.6 (latest) — 2016-07-17
- 1.1.3 — 2016-07-05
- 1.1.2 — 2016-07-05
- 1.1.1 — 2016-06-23
- 1.1.0 — 2016-06-23
- 1.0.12 — 2016-06-20
- 1.0.11 — 2016-06-10
- 1.0.10 — 2016-06-08
- 1.0.8 — 2016-06-07
- 1.0.7 — 2016-06-07
- 1.0.6 — 2016-06-07
- 1.0.3 — 2016-06-06
- 1.0.1 — 2016-06-06

## README

events-es5 
=========

[![NPM version][icon-nv]][link-nv]
[![Build Status][icon-bs]][link-bs]
[![Clean Code][icon-cc]][link-cc]
[![Dependency Status][icon-ds]][link-ds]
[![devDependency Status][icon-dds]][link-dds]
![License][icon-li]

## Browser support

Chrome, Safari, Firefox, Opera, IE9+
( If you want to use this module in IE8-, you need to modify `events.js` to replace the use 
of Array.prototype.slice(), .etc )

## Installation 

```shell
    npm install events-es5

    or 

    jspm install npm:events-es5
```

## Usage

You can use it both in node.js environment and in a browser.
  
* Use it as a Node module. 

```js

    // a.js
    var Events = require('events-es5');

    var WorkerManager = function () {
        this.events = new Events('message', 'error');   // Initialize events.
    };

    WorkerManager.prototype = {
        constructor: WorkerManager,

        work: function () {
            this.events.send('message', this, 'Working...');    // Dispatch messages to subscribers.
        }
    };

    // b.js
    var Company = function () {
        this._init();
    };

    Company.prototype = {
        constructor: Company,

        _init: function () {
            ...
            this._workerMgr = new WorkerManager();
            this._workerMgr.events.bind('message', this._receivedMsg.bind(this))  // Subscribe.
                                  .bind('error',   this._receivedErr.bind(this)); // Chainable.
        },

        _receivedMsg: function (workerMgr, msg) {
            alert(msg);
        },

        ...
    };

```

* Use it directly in a browser. You can simply put `events.js` in your project and 
  include it by html `script` tag.

```javascript

    // a.js
    var WorkerManager = function () {
        this.events = new nameSpace.Events('message', 'error');   // Initialize events.
    };

    // Before you use it in browsers, you probably will want to replace 'nameSpace' with a real 
    // namespace. Simply update events.js.

    ...
    ...

```

* Other methods in this module. ( The code of `events.js` is clean and well organized, 
  I recommend you read it directly.)

```javascript

    /**
     * Defines a list of events.
     * @param eventNames {String...}
     * @returns {Events}
     */
    declare(eventNames)         // e.g. declare('message', 'error');

    /**
     * Returns whether <eventName> has been defined.
     * @param eventName {String}
     * @returns {Boolean}
     */
    isSupported(eventName)      // e.g. isSupported('message');

    unbind(eventName, fn)

    numListeners(eventName)
    hasListeners(eventName)

    /**
     * Binds a listener to '_activate' event, this listener 
     * will be noticed when any public event starts to have listeners.
     *
     * @param fn {Function}
     * @returns {Events} A pointer to this instance, allowing call chaining.
     */   
    monitorActivation(fn)
    
    /**
     * Binds a listener to '_deactivate' event, this listener 
     * will be noticed when any public event have no listeners.
     *
     * @param fn {Function}
     * @returns {Events} A pointer to this instance, allowing call chaining.
     */
    monitorDeactivation(fn)

```

## Tests

```shell
    npm test          
```


[link-gh-pro-home]: https://github.com/wenwuwu/events-es5

[icon-nv]: https://img.shields.io/npm/v/events-es5.svg?style=flat
[link-nv]: https://www.npmjs.com/package/events-es5
[icon-bs]: https://travis-ci.org/wenwuwu/events-es5.svg?branch=master
[link-bs]: https://travis-ci.org/wenwuwu/events-es5
[icon-ds]: https://img.shields.io/david/wenwuwu/events-es5.svg?style=flat
[link-ds]: https://david-dm.org/wenwuwu/events-es5
[icon-dds]: https://img.shields.io/david/dev/wenwuwu/events-es5.svg?style=flat
[link-dds]: https://david-dm.org/wenwuwu/events-es5#info=devDependencies
[icon-cc]: https://img.shields.io/badge/code-clean-orange.svg?style=flat
[link-cc]: https://github.com/wenwuwu/code-convention-js 
[icon-li]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat

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