class EventEmitter<TSelf>
package js.node.events
extended by ChildProcess, Worker, Socket, Domain, FSWatcher, Server, Interface, REPLServer, SecurePair, Cluster, Process, Stream
Static variables
staticdefaultMaxListeners: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 also:
Constructor
Methods
addListener<T>(eventName:Event<T>, listener:T):TSelf
Alias for emitter.on(eventName, listener)
.
See also:
emit<T>(eventName:Event<T>, args:Rest<Dynamic>):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 also:
eventNames():Array<EitherType<String, Symbol>>
Returns an array listing the events for which the emitter has registered
listeners. The values in the array will be strings or Symbol
s.
See also:
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 also:
listenerCount<T>(eventName:Event<T>):Int
Returns the number of listeners listening to the event named eventName
.
See also:
listeners<T>(eventName:Event<T>):Array<T>
Returns a copy of the array of listeners for the event named eventName
.
See also:
on<T>(eventName:Event<T>, listener:T):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 also:
once<T>(eventName:Event<T>, listener:T):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 also:
prependListener<T>(eventName:Event<T>, listener:T):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 also:
prependOnceListener<T>(eventName:Event<T>, listener:T):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 also:
rawListeners<T>(eventName:Event<T>):Array<T>
Returns a copy of the array of listeners for the event named eventName
,
including any wrappers (such as those created by .once()
).
See also:
removeAllListeners<T>(?eventName:Event<T>):TSelf
Removes all listeners, or those of the specified eventName
.
See also:
removeListener<T>(eventName:Event<T>, listener:T):TSelf
Removes the specified listener
from the listener array for the event named
eventName
.
See also:
setMaxListeners(n:Int):Void
By default EventEmitter
s 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 also: