kotlin-electron/electron.core/UtilityProcess

UtilityProcess

external class UtilityProcess : EventEmitter(source)

Constructors

UtilityProcess

constructor()

Types

Companion

object Companion

Properties

pid

var pid: Double?

A Integer | undefined representing the process identifier (PID) of the child process. If the child process fails to spawn due to errors, then the value is undefined. When the child process exits, then the value is undefined after the exit event is emitted.

stderr

var stderr: ReadableStream?

A NodeJS.ReadableStream | null that represents the child process's stderr. If the child was spawned with options.stdio2 set to anything other than 'pipe', then this will be null. When the child process exits, then the value is null after the exit event is emitted.

stdout

var stdout: ReadableStream?

A NodeJS.ReadableStream | null that represents the child process's stdout. If the child was spawned with options.stdio1 set to anything other than 'pipe', then this will be null. When the child process exits, then the value is null after the exit event is emitted.

Functions

addListener

fun addListener(event: UtilityProcessEvent.EXIT, listener: (code: Double) -> Unit)

fun addListener(event: UtilityProcessEvent.MESSAGE, listener: (message: Any?) -> Unit)

fun addListener(event: UtilityProcessEvent.SPAWN, listener: Function<Unit>)

eventNames

fun eventNames(): Array<Any>

getMaxListeners

fun getMaxListeners(): Double

kill

fun kill(): Boolean

Terminates the process gracefully. On POSIX, it uses SIGTERM but will ensure the process is reaped on exit. This function returns true if the kill is successful, and false otherwise.

off

fun off(event: UtilityProcessEvent.EXIT, listener: (code: Double) -> Unit)

fun off(event: UtilityProcessEvent.MESSAGE, listener: (message: Any?) -> Unit)

fun off(event: UtilityProcessEvent.SPAWN, listener: Function<Unit>)

fun on(event: UtilityProcessEvent.EXIT, listener: (code: Double) -> Unit)

Emitted after the child process ends.

fun on(event: UtilityProcessEvent.MESSAGE, listener: (message: Any?) -> Unit)

Emitted when the child process sends a message using process.parentPort.postMessage().

fun on(event: UtilityProcessEvent.SPAWN, listener: Function<Unit>)

Emitted once the child process has spawned successfully.

once

fun once(event: UtilityProcessEvent.EXIT, listener: (code: Double) -> Unit)

fun once(event: UtilityProcessEvent.MESSAGE, listener: (message: Any?) -> Unit)

fun once(event: UtilityProcessEvent.SPAWN, listener: Function<Unit>)

postMessage

fun postMessage(message: Any?, transfer: ReadonlyArray<MessagePortMain> = definedExternally)

Send a message to the child process, optionally transferring ownership of zero or more MessagePortMain objects.

removeListener

fun removeListener(event: UtilityProcessEvent.EXIT, listener: (code: Double) -> Unit)

fun removeListener(event: UtilityProcessEvent.MESSAGE, listener: (message: Any?) -> Unit)

fun removeListener(event: UtilityProcessEvent.SPAWN, listener: Function<Unit>)

setMaxListeners

fun setMaxListeners(n: Number)