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

SpawnOptions

data class SpawnOptions : Record, IdentityProcOptions

Spawn Options

Defines options for the ChildProcessAPI.spawn method, which is used to asynchronously spawn a child process; these options extend ProcOptions.

Build spawn options from a foreign Value via the SpawnOptions.from method.

Types

Companion

object Companion

Factories and other helpers for SpawnOptions.

Properties

argv0

val argv0: String? = null

Explicitly set the value of argv[0] sent to the child process.

cwdString

open override val cwdString: String? = null

Current working directory, as a string.

cwdUrl

val cwdUrl: URL? = null

Current working directory, as a URL.

detached

val detached: Boolean = false

Whether to run the child process in a detached state.

encoding

open override val encoding: String?

Encoding to use for I/O.

env

open override val env: Map<String, String>? = null

Environment variables.

gid

open override val gid: Int? = null

Group ID to run the process as.

killSignal

open override val killSignal: String

Signal to use to kill the process.

maxBuffer

open override val maxBuffer: Int

Maximum buffer size for I/O.

serialization

val serialization: String

Serialization to use between processes.

shell

open override val shell: String? = null

Shell to invoke for the process.

stdio

open override val stdio: StdioConfig

Standard I/O configuration.

timeout

open override val timeout: Duration? = null

Timeout for the process, in seconds.

timeoutSeconds

open override val timeoutSeconds: Long?

Timeout for the process, in seconds.

uid

open override val uid: Int? = null

User ID to run the process as.

windowsHide

open override val windowsHide: Boolean

Whether to hide the process window.

windowsVerbatimArguments

val windowsVerbatimArguments: Boolean

Whether to use verbatim arguments on Windows.