kotlin-node/node.events/EventEmitter/Companion

Companion

object Companion(source)

Properties

captureRejections

var captureRejections: Boolean

Value: boolean

captureRejectionSymbol

val captureRejectionSymbol: ERROR CLASS: Symbol not found for js.symbol.Symbol

Value: Symbol.for('nodejs.rejection')

defaultMaxListeners

var defaultMaxListeners: Double

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 allEventEmitter instances, the events.defaultMaxListeners property can be used. If this value is not a positive number, a RangeError is thrown.

errorMonitor

val errorMonitor: ERROR CLASS: Symbol not found for js.symbol.Symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Functions

addAbortListener

fun addAbortListener(signal: ERROR CLASS: Symbol not found for AbortSignal, resource: (@R|kotlin/ParameterName|(name = String(event)) ERROR CLASS: Symbol not found for Event) -> Unit): ERROR CLASS: Symbol not found for Disposable

Listens once to the abort event on the provided signal.

getEventListeners

fun getEventListeners(emitter: ERROR CLASS: Symbol not found for EventTarget, type: ERROR CLASS: Symbol not found for web.events.EventType<*>): ERROR CLASS: Symbol not found for js.array.ReadonlyArray<kotlin/Function<*>>

fun getEventListeners(emitter: EventEmitter, type: EventType): ERROR CLASS: Symbol not found for js.array.ReadonlyArray<kotlin/Function<*>>

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

getMaxListeners

fun getMaxListeners(emitter: ERROR CLASS: Symbol not found for EventTarget): Double

fun getMaxListeners(emitter: EventEmitter): Double

Returns the currently set max amount of listeners.

listenerCount

fun listenerCount(emitter: EventEmitter, type: EventType): Double

A class method that returns the number of listeners for the given eventName registered on the given emitter.

fun <E : ERROR CLASS: Symbol not found for Event> on(emitter: ERROR CLASS: Symbol not found for EventTarget, type: ERROR CLASS: Symbol not found for web.events.EventType<E>, options: StaticEventEmitterOptions = definedExternally): ERROR CLASS: Symbol not found for AsyncIterator<ERROR CLASS: Symbol not found for Tuple1<E>>

fun <P : ERROR CLASS: Symbol not found for Tuple> on(emitter: EventEmitter, type: EventType, options: StaticEventEmitterOptions = definedExternally): ERROR CLASS: Symbol not found for AsyncIterator<P>

Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

once

fun <E : ERROR CLASS: Symbol not found for Event> once(emitter: ERROR CLASS: Symbol not found for EventTarget, type: ERROR CLASS: Symbol not found for web.events.EventType<E>, options: StaticEventEmitterOptions = definedExternally): ERROR CLASS: Symbol not found for Promise<ERROR CLASS: Symbol not found for Tuple1<E>>

fun <P : ERROR CLASS: Symbol not found for Tuple> once(emitter: EventEmitter, type: EventType, options: StaticEventEmitterOptions = definedExternally): ERROR CLASS: Symbol not found for Promise<P>

Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

setMaxListeners

fun setMaxListeners(n: Number = definedExternally, vararg eventTargets: Any)