kotlin-electron/electron.core/UtilityProcess

UtilityProcess

external class UtilityProcess(source)

Constructors

UtilityProcess

constructor()

Types

Companion

object Companion

Properties

errorEvent

val errorEvent: <Error class: unknown class><<Error class: unknown class><String, String, String>>

exitEvent

val exitEvent: <Error class: unknown class><<Error class: unknown class><Double>>

messageEvent

val messageEvent: <Error class: unknown class><<Error class: unknown class><Any?>>

pid

var pid: Double?

A Integer | undefined representing the process identifier (PID) of the child process. Until the child process has spawned successfully, the value is undefined. When the child process exits, then the value is undefined after the exit event is emitted.

spawnEvent

val spawnEvent: <Error class: unknown class><<Error class: unknown class>>

stderr

var stderr: <Error class: unknown class>?

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: <Error class: unknown class>?

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

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.

postMessage

fun postMessage(message: Any?, transfer: <Error class: unknown class><MessagePortMain> = definedExternally)

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