https://github.com/browserify/events

Node's event emitter for all engines.
https://github.com/browserify/events

Last synced: 6 days ago
JSON representation

Node's event emitter for all engines.

• Host: GitHub
• URL: https://github.com/browserify/events
• Owner: browserify
• License: mit
• Created: 2011-04-22T10:35:08.000Z (over 13 years ago)
• Default Branch: main
• Last Pushed: 2023-10-09T07:23:41.000Z (about 1 year ago)
• Last Synced: 2024-10-29T12:58:52.145Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 182 KB
• Stars: 1,380
• Watchers: 18
• Forks: 173
• Open Issues: 10
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Security: security.md

Awesome Lists containing this project

• stars - browserify/events

README

        
# events [![Build Status](https://travis-ci.org/browserify/events.png?branch=main)](https://travis-ci.org/browserify/events)

> Node's event emitter for all engines.

This implements the Node.js [`events`][node.js docs] module for environments that do not have it, like browsers.

> `events` currently matches the **Node.js 11.13.0** API.

Note that the `events` module uses ES5 features. If you need to support very old browsers like IE8, use a shim like [`es5-shim`](https://www.npmjs.com/package/es5-shim). You need both the shim and the sham versions of `es5-shim`.

This module is maintained, but only by very few people. If you'd like to help, let us know in the [Maintainer Needed](https://github.com/browserify/events/issues/43) issue!

## Install

You usually do not have to install `events` yourself! If your code runs in Node.js, `events` is built in. If your code runs in the browser, bundlers like [browserify](https://github.com/browserify/browserify) or [webpack](https://github.com/webpack/webpack) also include the `events` module.

But if none of those apply, with npm do:

```

npm install events

```

## Usage

```javascript

var EventEmitter = require('events')

var ee = new EventEmitter()

ee.on('message', function (text) {

  console.log(text)

})

ee.emit('message', 'hello world')

```

## API

See the [Node.js EventEmitter docs][node.js docs]. `events` currently matches the Node.js 11.13.0 API.

## Contributing

PRs are very welcome! The main way to contribute to `events` is by porting features, bugfixes and tests from Node.js. Ideally, code contributions to this module are copy-pasted from Node.js and transpiled to ES5, rather than reimplemented from scratch. Matching the Node.js code as closely as possible makes maintenance simpler when new changes land in Node.js.

This module intends to provide exactly the same API as Node.js, so features that are not available in the core `events` module will not be accepted. Feature requests should instead be directed at [nodejs/node](https://github.com/nodejs/node) and will be added to this module once they are implemented in Node.js.

If there is a difference in behaviour between Node.js's `events` module and this module, please open an issue!

## License

[MIT](./LICENSE)

[node.js docs]: https://nodejs.org/dist/v11.13.0/docs/api/events.html