@yaro.page/nano-events

📚 Events documentation

nano-events is a minimal implementation for event handling that can be used in any environment.

📦 EventEmitter Core

The EventEmitter class is a minimal implementation for event handling.

• .on(event, listener) registers a listener.
• .off(event, listener) removes a listener.
• .emit(event, data) notifies all listeners.

🌐 BrowserEventEmitter

BrowserEventEmitter extends EventEmitter to dispatch events using window or any EventTarget.

• on(event, listener) binds to native event with CustomEvent.detail.
• emit(event, data) dispatches CustomEvent with detail.
• off(event, listener) removes event binding.

🧪 Example Usage

import { BrowserEventEmitter } from '@yaro.page/nano-events'
const bus = new BrowserEventEmitter()
bus.on('hello', (data) => console.log(data))
bus.emit('hello', { msg: 'Hi 👋' })

Use with the node.js EventEmitter

import { EventEmitter as NodeEventEmitter } from 'node:events'
import { NanoEvent } from '@yaro.page/nano-events'
class NanoEventWithEmitter extends NanoEvent {
	createEmitter() {
		return new NodeEventEmitter()
	}
}
const bus = new NanoEventWithEmitter()
let processed = false
bus.on('hello', (data) => {
	processed = data
})
bus.emit('hello', { msg: 'Hi 👋' })
console.log(processed) // { msg: 'Hi 👋' }

📜 License

ISC License