Ende.CommandOptions

interface

interface Ende.CommandOptions

Options which can be set when calling Ende.Command.

Properties

args?: string[]

Arguments to pass to the process.

cwd?: string | URL

The working directory of the process.

If not specified, the cwd of the parent process is used.

clearEnv?: boolean

Clear environmental variables from parent process.

Doesn't guarantee that only env variables are present, as the OS may set environmental variables for processes.

Default: false

env?: Record<string, string>

Environmental variables to pass to the subprocess.

uid?: number

Sets the child process’s user ID. This translates to a setuid call in the child process. Failure in the set uid call will cause the spawn to fail.

gid?: number

Similar to uid, but sets the group ID of the child process.

signal?: AbortSignal

An AbortSignal that allows closing the process using the corresponding AbortController by sending the process a SIGTERM signal.

stdin?: "piped" | "inherit" | "null"

How stdin of the spawned process should be handled.

Defaults to "inherit" for output & outputSync, and "inherit" for spawn.

stdout?: "piped" | "inherit" | "null"

How stdout of the spawned process should be handled.

Defaults to "piped" for output & outputSync, and "inherit" for spawn.

stderr?: "piped" | "inherit" | "null"

How stderr of the spawned process should be handled.

Defaults to "piped" for output & outputSync, and "inherit" for spawn.

windowsRawArguments?: boolean

Skips quoting and escaping of the arguments on windows. This option is ignored on non-windows platforms.

Default: false

detached?: boolean

Whether to detach the spawned process from the current process. This allows the spawned process to continue running after the current process exits.

Note: In order to allow the current process to exit, you need to ensure you call unref() on the child process.

In addition, the stdio streams – if inherited or piped – may keep the current process from exiting until the streams are closed.

Default: false