Options
All
  • Public
  • Public/Protected
  • All
Menu

Add an error finder to SpawnPromietOptions to allow for poorly-behaved command-line tools that do not properly reflect their status in their return code.

Hierarchy

  • SpawnPromiseOptions
    • SpawnLogOptions

Index

Properties

Optional argv0

argv0: string

Optional cwd

cwd: string

Optional encoding

encoding: string

Optional env

env: ProcessEnv

Optional errorFinder

errorFinder: ErrorFinder

If your command can return zero on failure or non-zero on success, you can override the default behavior of determining success or failure using this option. For example, if your command returns zero for certain types of errors, you can scan the log content from the command to determine if an error occurs. If this function finds an error, the error property will be populated with an Error.

Optional gid

gid: number

Optional input

input: string | Buffer | NodeJS.TypedArray | DataView

Optional killSignal

killSignal: string | number

log

Make SpawnPromiseOptions log mandatory and a ProgressLog.

Optional logCommand

logCommand: boolean

Set to true if you want the command line sent to the Writablelog provided to spawnPromise. Set to false if the command or its arguments contain sensitive information.

Optional maxBuffer

maxBuffer: number

Optional shell

shell: boolean | string

Optional stdio

stdio: StdioOptions

Optional timeout

timeout: number
default

0

Optional uid

uid: number

Optional windowsHide

windowsHide: boolean
default

true

Optional windowsVerbatimArguments

windowsVerbatimArguments: boolean

Generated using TypeDoc