kotlin-electron/electron.core/UtilityProcess

UtilityProcess

external class UtilityProcess : EventEmitter(source)

Constructors

UtilityProcess

constructor()

Types

Companion

object Companion

Properties

exitEvent

val exitEvent: EventInstance<JsTuple1<Double>>

messageEvent

val messageEvent: EventInstance<JsTuple1<Any?>>

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.

spawnEvent

val spawnEvent: EventInstance<JsTuple>

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(type: EventType, listener: EventListener)

emit

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

eventNames

fun eventNames(): Array<EventType>

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.

listenerCount