ProcessOptions interface

Options shared by safe process operations.

Extends

Properties

gid

The numeric group identity of the process.

killSignal

The signal used to terminate the process.

shell

Shell execution is not supported.

timeout

The maximum execution time in milliseconds.

uid

The numeric user identity of the process.

windowsHide

Whether to hide the subprocess console window on Windows.

windowsVerbatimArguments

Windows command-line encoding is controlled by this package.

Inherited Properties

allowWindowsBatchFiles

Whether .cmd and .bat files may be selected on Windows.

Batch files only support a restricted argument set and are disabled by default.

cwd

The working directory used to resolve explicit relative paths.

env

The environment whose PATH is searched.

Property Details

gid

The numeric group identity of the process.

gid?: number

Property Value

number

killSignal

The signal used to terminate the process.

killSignal?: number | Signals

Property Value

number | Signals

shell

Shell execution is not supported.

shell?: undefined

Property Value

undefined

timeout

The maximum execution time in milliseconds.

timeout?: number

Property Value

number

uid

The numeric user identity of the process.

uid?: number

Property Value

number

windowsHide

Whether to hide the subprocess console window on Windows.

windowsHide?: boolean

Property Value

boolean

windowsVerbatimArguments

Windows command-line encoding is controlled by this package.

windowsVerbatimArguments?: undefined

Property Value

undefined

Inherited Property Details

allowWindowsBatchFiles

Whether .cmd and .bat files may be selected on Windows.

Batch files only support a restricted argument set and are disabled by default.

allowWindowsBatchFiles?: boolean

Property Value

boolean

Inherited From ResolveExecutableOptions.allowWindowsBatchFiles

cwd

The working directory used to resolve explicit relative paths.

cwd?: string | URL

Property Value

string | URL

Inherited From ResolveExecutableOptions.cwd

env

The environment whose PATH is searched.

env?: ProcessEnv

Property Value

ProcessEnv

Inherited From ResolveExecutableOptions.env