EventEmitter

View source
js.node.events.EventEmitter (extern class) → js.node.Process, js.node.Stream, js.node.child_process.ChildProcess, js.node.fs.FSWatcher

The EventEmitter class is defined and exposed by the events module:

See: https://nodejs.org/api/events.html#events_class_eventemitter

Static Members

defaultMaxListeners: Int

By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for all EventEmitter instances, the EventEmitter.defaultMaxListeners property can be used. If this value is not a positive number, a TypeError will be thrown.

See: https://nodejs.org/api/events.html#events_eventemitter_defaultmaxlisteners

Instance Members

addListener(eventName: Event<addListener.T>, listener: addListener.T): js.node.events.EventEmitter.TSelf

Alias for emitter.on(eventName, listener).

See: https://nodejs.org/api/events.html#events_emitter_addlistener_eventname_listener
Name Type
eventName Event<addListener.T>
listener addListener.T
Returns
js.node.events.EventEmitter.TSelf
emit(eventName: Event<emit.T>, args: haxe.extern.Rest): Bool

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

See: https://nodejs.org/api/events.html#events_emitter_emit_eventname_args
Name Type
eventName Event<emit.T>
args haxe.extern.Rest
Returns
Bool

Returns an array listing the events for which the emitter has registered listeners. The values in the array will be strings or Symbols.

See: https://nodejs.org/api/events.html#events_emitter_eventnames
Returns
Array<haxe.extern.EitherType<String, js.lib.Symbol>>
getMaxListeners(): Int

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

See: https://nodejs.org/api/events.html#events_emitter_getmaxlisteners
Returns
Int
listenerCount(eventName: Event<listenerCount.T>): Int

Returns the number of listeners listening to the event named eventName.

See: https://nodejs.org/api/events.html#events_emitter_listenercount_eventname
Name Type
eventName Event<listenerCount.T>
Returns
Int
listeners(eventName: Event<listeners.T>): Array<listeners.T>

Returns a copy of the array of listeners for the event named eventName.

See: https://nodejs.org/api/events.html#events_emitter_listeners_eventname
Name Type
eventName Event<listeners.T>
Returns
Array<listeners.T>
off(eventName: Event<off.T>, listener: off.T): js.node.events.EventEmitter.TSelf

Alias for emitter.removeListener().

See: https://nodejs.org/api/events.html#events_emitter_off_eventname_listener
Name Type
eventName Event<off.T>
listener off.T
Returns
js.node.events.EventEmitter.TSelf
on(eventName: Event<on.T>, listener: on.T): js.node.events.EventEmitter.TSelf

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

See: https://nodejs.org/api/events.html#events_emitter_on_eventname_listener
Name Type
eventName Event<on.T>
listener on.T
Returns
js.node.events.EventEmitter.TSelf
once(eventName: Event<once.T>, listener: once.T): js.node.events.EventEmitter.TSelf

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

See: https://nodejs.org/api/events.html#events_emitter_once_eventname_listener
Name Type
eventName Event<once.T>
listener once.T
Returns
js.node.events.EventEmitter.TSelf
prependListener(eventName: Event<prependListener.T>, listener: prependListener.T): js.node.events.EventEmitter.TSelf

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

See: https://nodejs.org/api/events.html#events_emitter_prependlistener_eventname_listener
Name Type
eventName Event<prependListener.T>
listener prependListener.T
Returns
js.node.events.EventEmitter.TSelf
prependOnceListener(eventName: Event<prependOnceListener.T>, listener: prependOnceListener.T): js.node.events.EventEmitter.TSelf

Adds a one-time listener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

See: https://nodejs.org/api/events.html#events_emitter_prependoncelistener_eventname_listener
Name Type
eventName Event<prependOnceListener.T>
listener prependOnceListener.T
Returns
js.node.events.EventEmitter.TSelf
removeAllListeners(?eventName: Event<removeAllListeners.T>): js.node.events.EventEmitter.TSelf

Removes all listeners, or those of the specified eventName.

See: https://nodejs.org/api/events.html#events_emitter_removealllisteners_eventname
Name Type Default
eventName Event<removeAllListeners.T> (optional)
Returns
js.node.events.EventEmitter.TSelf
removeListener(eventName: Event<removeListener.T>, listener: removeListener.T): js.node.events.EventEmitter.TSelf

Removes the specified listener from the listener array for the event named eventName.

See: https://nodejs.org/api/events.html#events_emitter_removelistener_eventname_listener
Name Type
eventName Event<removeListener.T>
listener removeListener.T
Returns
js.node.events.EventEmitter.TSelf
setMaxListeners(n: Int): Void

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. Obviously, not all events should be limited to just 10 listeners. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

See: https://nodejs.org/api/events.html#events_emitter_setmaxlisteners_n
Name Type
n Int
rawListeners(eventName: Event<rawListeners.T>): Array<rawListeners.T>

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

See: https://nodejs.org/api/events.html#events_emitter_rawlisteners_eventname
Name Type
eventName Event<rawListeners.T>
Returns
Array<rawListeners.T>
new(): Void

Metadata

Name Parameters
:jsRequire "events", "EventEmitter"