ExecFileOptions interface

Package:

@azure/core-process

Options for execFile.

Extends

ProcessOptions

Properties

encoding	The character encoding used for buffered output.
maxBuffer	The maximum number of bytes allowed on stdout or stderr.
signal	An abort signal for process cancellation.

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.
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.

Property Details

encoding

The character encoding used for buffered output.

encoding?: null | BufferEncoding | "buffer"

Property Value

null | BufferEncoding | "buffer"

maxBuffer

The maximum number of bytes allowed on stdout or stderr.

maxBuffer?: number

Property Value

number

signal

An abort signal for process cancellation.

signal?: AbortSignal

Property Value

AbortSignal

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 ProcessOptions.allowWindowsBatchFiles

cwd

The working directory used to resolve explicit relative paths.

cwd?: string | URL

Property Value

string | URL

Inherited From ProcessOptions.cwd

env

The environment whose PATH is searched.

env?: ProcessEnv

Property Value

ProcessEnv

Inherited From ProcessOptions.env

gid

The numeric group identity of the process.

gid?: number

Property Value

number

Inherited From ProcessOptions.gid

killSignal

The signal used to terminate the process.

killSignal?: number | Signals

Property Value

number | Signals

Inherited From ProcessOptions.killSignal

shell

Shell execution is not supported.

shell?: undefined

Property Value

undefined

Inherited From ProcessOptions.shell

timeout

The maximum execution time in milliseconds.

timeout?: number

Property Value

number

Inherited From ProcessOptions.timeout

uid

The numeric user identity of the process.

uid?: number

Property Value

number

Inherited From ProcessOptions.uid

windowsHide

Whether to hide the subprocess console window on Windows.

windowsHide?: boolean

Property Value

boolean

Inherited From ProcessOptions.windowsHide

windowsVerbatimArguments

Windows command-line encoding is controlled by this package.

windowsVerbatimArguments?: undefined

Property Value

undefined

Inherited From ProcessOptions.windowsVerbatimArguments