Type Alias RunShellCommandOptions

RunShellCommandOptions: {
    cwd?: string;
    env?: NodeJS.ProcessEnv;
    hookUpToConsole?: boolean;
    rejectOnError?: boolean;
    shell?: string;
    stderrCallback?: (
        stderr: string,
        childProcess: ChildProcess,
    ) => MaybePromise<void> | undefined;
    stdoutCallback?: (
        stdout: string,
        childProcess: ChildProcess,
    ) => MaybePromise<void> | undefined;
}

Options for runShellCommand.

Type declaration

  • Optionalcwd?: string
  • Optionalenv?: NodeJS.ProcessEnv
  • OptionalhookUpToConsole?: boolean

    Automatically hook up stdout and stderr printing to the caller's console methods.

  • OptionalrejectOnError?: boolean
  • Optionalshell?: string
  • OptionalstderrCallback?: (stderr: string, childProcess: ChildProcess) => MaybePromise<void> | undefined

    Callback to call whenever the shell logs to stderr.

  • OptionalstdoutCallback?: (stdout: string, childProcess: ChildProcess) => MaybePromise<void> | undefined

    Callback to call whenever the shell logs to stdout.

Package

@augment-vir/node

Settings

Member Visibility