Skip to content

ExecSimpleOptions

Options for exec that return only stdout.

Import:

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

Signature:

export interface ExecSimpleOptions 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)
shouldIncludeDetails?falseMust be false or omitted to receive only stdout.
stdin?stringAn input to be passed to the command.
(Inherited from ExecOptions)