Skip to content

ExecDetailedOptions

Options for exec that return detailed results.

Import:

import type { ExecDetailedOptions } from 'obsidian-dev-utils/script-utils/exec';

Signature:

export interface ExecDetailedOptions extends ExecOptions

Extends: ExecOptions

Properties

PropertyTypeDescription
cwd?stringA current working folder for the command execution.
(Inherited from ExecOptions)
env?NodeJS.ProcessEnvAdditional environment variables for the child process, merged over the inherited environment.
(Inherited from ExecOptions)
isInteractive?booleanIf 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.
(Inherited from ExecOptions)
isQuiet?booleanIf true, suppresses the output of the command.
(Inherited from ExecOptions)
shouldFailIfCalledFromOutsideRoot?booleanIf true, throws an error if the command fails.
(Inherited from ExecOptions)
shouldIgnoreExitCode?booleanIf true, ignores the exit code of the command.
(Inherited from ExecOptions)
shouldIncludeDetailstrueMust be true to receive detailed results.
shouldIncludeDetails?booleanIf false, only returns the output of the command.
(Inherited from ExecOptions)
stdin?stringAn input to be passed to the command.
(Inherited from ExecOptions)