ExecOptions

Exec Options

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

Build exec options from a foreign Value via the ExecOptions.from method.

Types

Link copied to clipboard
object Companion

Factories and other helpers for ExecOptions.

Properties

Link copied to clipboard
open override val cwdString: String? = null

Current working directory, as a string.

Link copied to clipboard
val cwdUrl: URL? = null

Current working directory, as a URL.

Link copied to clipboard
open override val encoding: String?

Encoding to use for I/O.

Link copied to clipboard
open override val env: Map<String, String>? = null

Environment variables.

Link copied to clipboard
open override val gid: Int? = null

Group ID to run the process as.

Link copied to clipboard
open override val killSignal: String

Signal to use to kill the process.

Link copied to clipboard
open override val maxBuffer: Int

Maximum buffer size for I/O.

Link copied to clipboard
open override val shell: String? = null

Shell to invoke for the process.

Link copied to clipboard
open override val stdio: StdioConfig

Standard I/O configuration.

Link copied to clipboard
open override val timeout: Duration? = null

Timeout for the process, in seconds.

Link copied to clipboard
open override val timeoutSeconds: Long?

Timeout for the process, in seconds.

Link copied to clipboard
open override val uid: Int? = null

User ID to run the process as.

Link copied to clipboard
open override val windowsHide: Boolean

Whether to hide the process window.