ExecFileOptionsWithStringEncoding interface

Package:

@azure/core-process

String-encoding options for execFile.

Extends

Omit<ExecFileOptions, "encoding">

Properties

encoding

The character encoding used for captured output.

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.
maxBuffer	The maximum number of bytes allowed on stdout or stderr.
shell	Shell execution is not supported.
signal	An abort signal for process cancellation.
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 captured output.

encoding?: BufferEncoding

Property Value

BufferEncoding

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

cwd

The working directory used to resolve explicit relative paths.

cwd?: string | URL

Property Value

string | URL

Inherited From Omit.cwd

env

The environment whose PATH is searched.

env?: ProcessEnv

Property Value

ProcessEnv

Inherited From Omit.env

gid

The numeric group identity of the process.

gid?: number

Property Value

number

Inherited From Omit.gid

killSignal

The signal used to terminate the process.

killSignal?: number | Signals

Property Value

number | Signals

Inherited From Omit.killSignal

maxBuffer

The maximum number of bytes allowed on stdout or stderr.

maxBuffer?: number

Property Value

number

Inherited From Omit.maxBuffer

shell

Shell execution is not supported.

shell?: undefined

Property Value

undefined

Inherited From Omit.shell

signal

An abort signal for process cancellation.

signal?: AbortSignal

Property Value

AbortSignal

Inherited From Omit.signal

timeout

The maximum execution time in milliseconds.

timeout?: number

Property Value

number

Inherited From Omit.timeout

uid

The numeric user identity of the process.

uid?: number

Property Value

number

Inherited From Omit.uid

windowsHide

Whether to hide the subprocess console window on Windows.

windowsHide?: boolean

Property Value

boolean

Inherited From Omit.windowsHide

windowsVerbatimArguments

Windows command-line encoding is controlled by this package.

windowsVerbatimArguments?: undefined

Property Value

undefined

Inherited From Omit.windowsVerbatimArguments