tiny-emitter-cve-fixes
v2.3.0
Published
A fork of tiny-emitter by Scott Corgan with fixed CVEs and updated build process.
Downloads
32
Maintainers
Readme
tiny-emitter-cve-fixes
A tiny (less than 1k) event emitter library. This is a security-focused fork of the original tiny-emitter with fixed CVEs and prototype pollution protection.
Why this fork?
The original repository has not been updated for several years and contains dependencies with known vulnerabilities (CVEs). This fork aims to provide a drop-in replacement that:
- Fixes prototype pollution vulnerabilities.
- Replaces build tooling to avoid vulnerable dependencies
Install
npm
npm install tiny-emitter-cve-fixes --saveUsage
var Emitter = require('tiny-emitter-cve-fixes');
var emitter = new Emitter();
emitter.on('some-event', function (arg1, arg2, arg3) {
//
});
emitter.emit('some-event', 'arg1 value', 'arg2 value', 'arg3 value');Alternatively, you can skip the initialization step by requiring tiny-emitter-cve-fixes/instance instead. This pulls in an already initialized emitter.
var emitter = require('tiny-emitter-cve-fixes/instance');
emitter.on('some-event', function (arg1, arg2, arg3) {
//
});
emitter.emit('some-event', 'arg1 value', 'arg2 value', 'arg3 value');Instance Methods
on(event, callback[, context])
Subscribe to an event
event- the name of the event to subscribe tocallback- the function to call when event is emittedcontext- (OPTIONAL) - the context to bind the event callback to
once(event, callback[, context])
Subscribe to an event only once
event- the name of the event to subscribe tocallback- the function to call when event is emittedcontext- (OPTIONAL) - the context to bind the event callback to
off(event[, callback])
Unsubscribe from an event or all events. If no callback is provided, it unsubscribes you from all events.
event- the name of the event to unsubscribe fromcallback- the function used when binding to the event
emit(event[, arguments...])
Trigger a named event
event- the event name to emitarguments...- any number of arguments to pass to the event subscribers
Test and Build
Build (Tests, Browserifies, and minifies)
npm install
npm run buildTest
npm install
npm testLicense
Original Author: Scott Corrigan
