@ionic/utils-subprocess

constructor

constructor(name: string, args: readonly string[], options?: SubprocessOptions);

property args

args: readonly string[];

property name

name: string;

property options

readonly options: SpawnOptions;

property path

protected readonly path?: string;

method bashify

bashify: ({
    maskArgv0,
    maskArgv1,
    shiftArgv0,
}?: SubprocessBashifyOptions) => string;

method bashifyArg

bashifyArg: (arg: string) => string;

method combinedOutput

combinedOutput: () => Promise<string>;

method maskArg

maskArg: (arg: string) => string;

method output

output: () => Promise<string>;

method run

run: () => Promise<void> & { p: ChildProcess };

method spawn

spawn: () => ChildProcess;

property code

code?:
    | 'ERR_SUBPROCESS_COMMAND_NOT_FOUND'
    | 'ERR_SUBPROCESS_NON_ZERO_EXIT'
    | 'ERR_SUBPROCESS_SIGNAL_EXIT';

property exitCode

exitCode?: number;

property name

readonly name: string;

property output

output?: string;

property signal

signal?: string;

property maskArgv0

maskArgv0?: boolean;

• Mask file path to first argument.

  The first argument to subprocesses is the program name or path, e.g. /path/to/bin/my-program. If true, bashify() will return the program name without a file path, e.g. my-program.

  The default is true.

property maskArgv1

maskArgv1?: boolean;

• Mask file path to second argument.

  In some subprocesses, the second argument is a script file to run, e.g. node ./scripts/post-install. If true, bashify() will return the script name without a file path, e.g. node post-install.

  The default is false.

property shiftArgv0

shiftArgv0?: boolean;

• Remove the first argument from output.

  Useful to make a command such as node ./scripts/post-install appear as simply post-install.

  The default is false.

property PATH

PATH?: string;

property PATHEXT

PATHEXT?: string;