graalvm/elide.runtime.node.childProcess/ChildProcessSyncHandle

ChildProcessSyncHandle

class ChildProcessSyncHandle : AbstractChildProcessHandle, ProxyObject, ChildProcessSync

Node API: Child Process Handle (Synchronous)

Represents a ChildProcess which executed synchronously, and therefore has already terminated; this object provides access to the pid used for the process, plus stdout and stderr streams, and the status exit of the process (or a signal if the process exited through a signal).

Properties

error

open override val error: JsError?

Error object, if the process failed to start or exited with a non-zero exit code.

output

open override val output: LazyProcessOutput

Standard output and error streams for the child process.

pid

open override val pid: Long

Process ID for the child process.

signal

open override val signal: String?

Signal which caused the process to terminate, if any.

status

open override val status: Int?

Exit status for the process, or null if the subprocess terminated due to a signal.

stderr

open override val stderr: ProcessOutputStream?

Standard error stream for the child process.

stdout

open override val stdout: ProcessOutputStream?

Standard output stream for the child process.

Functions

addEventListener

open override fun addEventListener(type: String, listener: EventListener)

Adds a new handler for the type event. Any given listener is added only once per type and per capture option value.

open override fun addEventListener(type: String, options: AddEventListenerOptions, listener: EventListener)

Adds a new handler for the type event. Any given listener is added only once per type and per capture option value.

open override fun addEventListener(type: String, listener: Value, options: Value?)

Adds a new handler for the type event. Any given listener is added only once per type and per capture option value.

addListener

open override fun addListener(eventName: String, listener: EventListener)

open override fun addListener(eventName: String, listener: Value)

Alias for emitter.on(eventName, listener).

open override fun close()

dispatchEvent

open override fun dispatchEvent(event: Event): Boolean

Dispatches the event to the list of handlers for Event.type.

emit

open override fun emit(eventName: String, 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.

eventNames

open override fun eventNames(): List<String>

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

getMaxListeners

open override fun getMaxListeners(): Int

Returns the current max listener value for the emitter.

getMember

open override fun getMember(key: String?): Any?

getMemberKeys

open override fun getMemberKeys(): Array<String>

hasMember

open override fun hasMember(key: String?): Boolean

listenerCount

open override fun listenerCount(eventName: String): Int

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

listeners

open override fun listeners(eventName: String): List<EventListener>

Returns an array listing the listeners for the specified event.

off

open override fun off(eventName: String, listener: Value)

Alias for emitter.removeListener(eventName, listener).

open override fun on(eventName: String, listener: EventListener): EventEmitter

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.

open override fun on(eventName: String, listener: Value): EventEmitter

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.

once

open override fun once(eventName: String, 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.

open override fun once(eventName: String, listener: Value)

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

open override fun prependListener(eventName: String, listener: EventListener)

open override fun prependListener(eventName: String, listener: Value)

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.

prependOnceListener

open override fun prependOnceListener(eventName: String, listener: EventListener)

open override fun prependOnceListener(eventName: String, listener: Value)

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

putMember

open override fun putMember(key: String?, value: Value?)

rawListeners

open override fun rawListeners(eventName: String): List<EventListener>

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

removeAllListeners

open override fun removeAllListeners()

Removes all listeners, or those of the specified eventName.

open override fun removeAllListeners(eventName: String)

Removes all listeners, or those of the specified eventName.

removeEventListener

open override fun removeEventListener(type: String, listener: EventListener)

open override fun removeEventListener(type: String, listener: Value)

open override fun removeEventListener(type: String, listener: EventListener, options: RemoveEventListenerOptions)

open override fun removeEventListener(type: String, listener: EventListener, options: Value)

open override fun removeEventListener(type: String, listener: Value, options: Value)

Removes the listener from the list of handlers for event type.

removeListener

open override fun removeListener(eventName: String, listener: Value)

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

removeMember

open override fun removeMember(key: String?): Boolean

setMaxListeners

open override fun setMaxListeners(count: Int)

Sets the maximum number of listeners for the emitter.