Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
small-emitter
Advanced tools
Readme
English | 简体中文
A small event emitter library.
Install with npm
npm i small-emitter
# or pnpm add small-emitter
Import in the project
// ES6 modules
import { Emitter } from 'small-emitter'
// CommonJS modules
const { Emitter } = require('small-emitter')
import { Emitter } from 'small-emitter'
const emitter = new Emitter();
// subscribe to events
emitter.on('foo', function (p1, p2, p3) {
// ...
});
// subscribe the event only once
emitter.once('foo', function (p1, p2, p3) {
// ...
});
// publish events
emitter.emit('foo', 'p1', 'p2', 'p3');
// clearing all events
emitter.clear()
// use reference functions
function fn() {}
emitter.on('foo', fn)
emitter.off('foo', fn)
on<T extends Function>(name: string, callback: T)
Arguments
name
name of the eventcallback
event's callback functionExample
const emitter = new Emitter()
emitter.on('foo', (data) => {
console.log(data)
})
emitter.emit('foo', 1) // 1
emitter.emit('foo', 2) // 2
once<T extends Function>(name: string, callback: T)
Arguments
name
name of the eventcallback
event's callback functionExample
const emitter = new Emitter()
emitter.once('foo', (data) => {
// The function will only be executed once
console.log(data)
})
emitter.emit('foo', 'a') // 'a'
emitter.emit('foo', 'b') // Not output
emit<T extends unknown[]>(name: string, ...args: T)
Arguments
name
name of the event...args (optional)
parameters passed in by the execution eventExample
const emitter = new Emitter()
emitter.once('bar', (message, name) => {
console.log(`${message}, ${name}`)
})
emitter.emit('bar', 'hi', 'Jack') // hi, Jack
off<T extends Function>(name: string, callback?: T)
Arguments
name
name of the eventcallback (optional)
functions that need to be cleared or function referenceExample
const emitter = new Emitter()
const fn = (message) => {
console.log(message)
}
emitter.on('bar', fn)
emitter.emit('bar', 'hi') // hi
emitter.off('bar', fn)
emitter.emit('bar', 'Jack') // Not output
clear()
Calling this method will clear all events
Example
const emitter = new Emitter()
emitter.on('foo', (value) => {
console.log(value)
})
emitter.on('bar', (value) => {
console.log(value)
})
emitter.emit('foo', 'hi, foo')
emitter.emit('bar', 'hi, bar') // hi, bar
emitter.clear()
emitter.emit('foo', 'hi, Jack') // Not output
emitter.emit('bar', 'hi, Tom') // Not output
FAQs
A small event emitter library
The npm package small-emitter receives a total of 1 weekly downloads. As such, small-emitter popularity was classified as not popular.
We found that small-emitter demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.