1.0.1 • Published 6 years ago

events.off v1.0.1

Weekly downloads
1
License
MIT
Repository
github
Last release
6 years ago

events.off

Build Status npm

Polyfill for events.EventEmitter.prototype.off in node versions < v10

node v10.0.0 added support for a built-in events.EventEmitter.prototype.off: https://github.com/nodejs/node/pull/17156

This package provides the built-in events.EventEmitter.prototype.off in node v10.0.0 and later, and a replacement in other environments.

This package implements the es-shim API interface. It works in an ES3-supported environment and complies with the spec.

Usage

Direct

const off = require('events.off');
// Use `off` just like the built-in method on `events.EventEmitter.prototype`
const events = require('events');
const emitter = new events.EventEmitter();
const handler = () => {};
emitter.on('foo', handler);
// Use `off`
off(emitter, 'foo', handler);

Shim

require('events.off/shim')();
// `events.EventEmitter.prototype.off` is now defined
const events = require('events');
const emitter = new events.EventEmitter();
const handler = () => {};
emitter.on('foo', handler);
// Use `emitter.off`
emitter.off('foo', handler);

or:

require('events.off/auto');
// `events.off` is now defined
const events = require('events');
const emitter = new events.EventEmitter();
const handler = () => {};
emitter.on('foo', handler);
// Use `emitter.off`
emitter.off('foo', handler);