events
Source: lib/events.js (pure JS) — default export: EventEmitter
Node-style EventEmitter plus a WHATWG-style EventTarget.
Exports
| Export | Kind | Description |
|---|---|---|
EventEmitter | class | Node's event emitter, see below. (default export) |
EventTarget | class | DOM-style addEventListener(type, fn, { once, signal })/removeEventListener/dispatchEvent (returns false when the default was prevented; sets target and currentTarget of a lib/dom.js Event). The same class is in qjs-lws lib/lws/events.js. |
Node conformance
EventEmitter follows Node: handlers receive only the emit() arguments; on, once,
off, addListener, prependListener, prependOnceListener, removeListener and
removeAllListeners return the emitter; emit() returns whether a handler ran;
emit('error') without a listener throws; newListener/removeListener events;
listeners(), rawListeners(), listenerCount(), eventNames(), setMaxListeners(),
getMaxListeners(), EventEmitter.defaultMaxListeners. Event types may be strings or symbols.
| Export | Meaning |
|---|---|
once(emitter, type) | promise of the emit() argument array (EventEmitter) or the event (EventTarget); rejects on 'error' |
on(emitter, type, { signal }?) | async iterator over emit() argument arrays |
getEventListeners(emitter, type), listenerCount(emitter, type) | |
getMaxListeners(emitter), setMaxListeners(n, ...targets), defaultMaxListeners |
Export list
Generated by utilities/doc-api.js from the events dump of utilities/api-surface.sh: 34 members. Edit the text above this block, not the block.
Functions: EventTargetProperties(), waitOne()
EventTarget
class, constructible
- methods:
addEventListener(),dispatchEvent(),removeEventListener() - properties:
[Symbol.toStringTag]
default
class, constructible
- static methods:
EventEmitter(),getEventListeners(),getMaxListeners(),listenerCount(),on(),once(),setMaxListeners() - static values:
defaultMaxListeners = 10 - methods:
addListener(),emit(),eventNames(),getMaxListeners(),listenerCount(),listeners(),off(),on(),once(),prependListener(),prependOnceListener(),rawListeners(),removeAllListeners(),removeListener(),setMaxListeners() - properties:
[Symbol.toStringTag]