Skip to main content

CommandOptions

interface Deno.CommandOptions

Options which can be set when calling Deno.Command.

Properties Jump to heading

optional
Jump to headingargs: string[]

Arguments to pass to the process.

optional
Jump to headingcwd: string | URL

The working directory of the process.

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

optional
Jump to headingclearEnv: boolean = false

Clear environmental variables from parent process.

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

optional
Jump to headingenv: Record<string, string>

Environmental variables to pass to the subprocess.

optional
Jump to headinguid: 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.

optional
Jump to headinggid: number

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

optional
Jump to headingsignal: AbortSignal

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

Not supported in Deno.Command.outputSync.

optional
Jump to headingstdin:
"piped"
| "inherit"
| "null"

How stdin of the spawned process should be handled.

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

optional
Jump to headingstdout:
"piped"
| "inherit"
| "null"

How stdout of the spawned process should be handled.

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

optional
Jump to headingstderr:
"piped"
| "inherit"
| "null"

How stderr of the spawned process should be handled.

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

optional
Jump to headingwindowsRawArguments: boolean = false

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

Back to top