ExecOptions
Options for executing a command.
Import:
import type { ExecOptions } from 'obsidian-dev-utils/script-utils/exec';Signature:
export interface ExecOptionsProperties
| Property | Type | Description |
|---|---|---|
| cwd? | string | A current working folder for the command execution. |
| env? | NodeJS.ProcessEnv | Additional environment variables for the child process, merged over the inherited environment. |
| isInteractive? | boolean | If true, attaches the child process's stdio directly to the terminal (stdio: 'inherit') instead of capturing it. Use for long-running or interactive commands such as dev servers and watch mode. Because the output is not captured, the resolved stdout is an empty string. |
| isQuiet? | boolean | If true, suppresses the output of the command. |
| shouldFailIfCalledFromOutsideRoot? | boolean | If true, throws an error if the command fails. |
| shouldIgnoreExitCode? | boolean | If true, ignores the exit code of the command. |
| shouldIncludeDetails? | boolean | If false, only returns the output of the command. |
| stdin? | string | An input to be passed to the command. |
Links to this page: