kotlin-node/node/WritableStream

WritableStream

external interface WritableStream : EventEmitter(source)

Inheritors

ReadWriteStream

Writable

Properties

writable

abstract external var writable: Boolean

Functions

addListener

external fun addListener(type: EventType, listener: EventListener)

Alias for emitter.on(eventName, listener).

emit

external fun emit(type: EventType, vararg args: Any?): Boolean

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

end

abstract external fun end(cb: () -> Unit = definedExternally)

abstract external fun end(data: Uint8Array<*>, cb: () -> Unit = definedExternally)

abstract external fun end(data: String, cb: () -> Unit = definedExternally)

abstract external fun end(str: String, encoding: BufferEncoding = definedExternally, cb: () -> Unit = definedExternally)

eventNames

external fun eventNames(): ReadonlyArray<EventType>

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

getMaxListeners

external fun getMaxListeners(): Double

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

listenerCount

external fun listenerCount(type: EventType, listener: EventListener = definedExternally): Double

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

listeners

external fun listeners(type: EventType): ReadonlyArray<EventListener>

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

off

external fun off(type: EventType, listener: EventListener)

Alias for emitter.removeListener().

external fun on(type: EventType, listener: EventListener)

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.

once

external fun once(type: EventType, listener: EventListener)

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

prependListener

external fun prependListener(type: EventType, listener: EventListener)

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.

prependOnceListener

external fun prependOnceListener(type: EventType, listener: EventListener)

Adds a one-timelistener 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.

rawListeners

external fun rawListeners(type: EventType): ReadonlyArray<EventListener>

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

removeAllListeners

external fun removeAllListeners(type: EventType = definedExternally)

Removes all listeners, or those of the specified eventName.

removeListener

external fun removeListener(type: EventType, listener: EventListener)

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

setMaxListeners

external fun setMaxListeners(n: Number)

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. 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.

write

abstract external fun write(buffer: Uint8Array<*>, cb: (JsError?) -> Unit = definedExternally): Boolean

abstract external fun write(buffer: String, cb: (JsError?) -> Unit = definedExternally): Boolean

abstract external fun write(str: String, encoding: BufferEncoding = definedExternally, cb: (JsError?) -> Unit = definedExternally): Boolean