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

ProcOptions

@API
sealed interface ProcOptions

Process Options

Defines base options which relate to process launching through the Node Child Process API; these options are further used/extended from concrete options types, such as ExecSyncOptions.

Inheritors

Properties

Link copied to clipboard
abstract val cwdString: String?

Provides the set current-working-directory for a process operation as a String value.

Link copied to clipboard
abstract val encoding: String?

Encoding string specified by the user, as their desired output stream encoding.

Link copied to clipboard
abstract val env: Map<String, String>?

Provides a set of environment variables for a process operation; if not provided (null), the current environment is used.

Link copied to clipboard
abstract val killSignal: String

Signal which is preferred for use when killing this process.

Link copied to clipboard
abstract val maxBuffer: Int?

Maximum buffer size for process outputs; a reasonable default is provided.

Link copied to clipboard
abstract val shell: String?

Shell to wrap this command in, if applicable/desired.

Link copied to clipboard
abstract val stdio: StdioConfig

Specifies configurations for I/O streams for a process operation.

Link copied to clipboard
abstract val timeout: Duration?

Provides a timeout value for a process operation, in seconds.

Link copied to clipboard
abstract val timeoutSeconds: Long?

Timeout, in seconds, after which the process should no longer be allowed to live.

Link copied to clipboard
abstract val windowsHide: Boolean?

Whether to hide the process window for this process, if running on Windows; inert on all other platforms.