graalvm/elide.runtime.intrinsics.js.node.childProcess/ChildProcess

ChildProcess

interface ChildProcess : EventTarget, EventEmitter, ProcessChannel

Child Process

Describes the API made available for a child process handle; objects of this type are typically returned from Node Process API methods like spawn, which give the caller direct control over the spawned subprocess.

Inheritors

ChildProcessHandle

Properties

channel

abstract val channel: ProcessChannel?

Channel used to communicate with the underlying process.

connected

abstract val connected: Boolean

Whether the subprocess is active and connected.

exitCode

abstract val exitCode: Int?

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

killed

abstract val killed: Boolean

Whether the process terminated by being killed.

pid

abstract val pid: Long

Returns the process ID for the child process.

signalCode

abstract val signalCode: String?

Terminal signal code for the process, or null if the subprocess terminated normally.

stderr

abstract val stderr: ProcessOutputStream?

Standard error output stream for the child process.

stdin

abstract val stdin: ProcessInputStream?

Standard input stream for the child process.

stdio

abstract val stdio: ProcessIOChannels

Standard error output stream for the child process.

stdout

abstract val stdout: ProcessOutputStream?

Standard output stream for the child process.

Functions

addEventListener

abstract fun addEventListener(type: String, listener: EventListener)

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

abstract 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

abstract fun addListener(eventName: String, listener: EventListener)

abstract fun addListener(eventName: String, listener: Value)

Alias for emitter.on(eventName, listener).

abstract override fun close()

disconnect

abstract fun disconnect()

Disconnects the child process from the parent.

dispatchEvent

abstract fun dispatchEvent(event: Event): Boolean

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

emit

abstract 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

abstract 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

abstract fun getMaxListeners(): Int

Returns the current max listener value for the emitter.

kill

abstract fun kill(signal: String? = null)

Kills the child process, using the provided signal.

listenerCount

abstract fun listenerCount(eventName: String): Int

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

listeners

abstract fun listeners(eventName: String): List<EventListener>

Returns an array listing the listeners for the specified event.

off

abstract fun off(eventName: String, listener: Value)

Alias for emitter.removeListener(eventName, listener).

abstract fun on(eventName: String, listener: EventListener): EventEmitter

abstract 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

abstract fun once(eventName: String, listener: EventListener)

abstract 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

abstract fun prependListener(eventName: String, listener: EventListener)

abstract 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

abstract fun prependOnceListener(eventName: String, listener: EventListener)

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

rawListeners

abstract 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()).

ref

abstract fun ref(): ProcessChannel

removeAllListeners

abstract fun removeAllListeners()

Removes all listeners, or those of the specified eventName.

abstract fun removeAllListeners(eventName: String)

Removes all listeners, or those of the specified eventName.

removeEventListener

abstract fun removeEventListener(type: String, listener: EventListener)

abstract fun removeEventListener(type: String, listener: Value)

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

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

abstract fun removeEventListener(type: String, listener: Value, options: Value)

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

removeListener

abstract fun removeListener(eventName: String, listener: Value)

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

send

abstract fun send(message: Value, sendHandle: Value?, options: Value?, callback: Value?): Boolean

setMaxListeners

abstract fun setMaxListeners(count: Int)

Sets the maximum number of listeners for the emitter.

unref

abstract fun unref(): ProcessChannel

wait

abstract fun wait(): Int

Non-standard method which waits for process exit.