SpawnSyncOptions interface

Package:

@azure/core-process

Options for spawnSync.

Extends

ProcessOptions

Properties

argv0	The value used for argv[0] in the child process.
encoding	The encoding used for captured output.
input	Content written to the child process's standard input.
maxBuffer	The maximum number of bytes allowed on stdout or stderr.
stdio	Standard input, output, and error mappings.

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

argv0

The value used for argv[0] in the child process.

argv0?: string

Property Value

string

encoding

The encoding used for captured output.

encoding?: null | BufferEncoding | "buffer"

Property Value

null | BufferEncoding | "buffer"

input

Content written to the child process's standard input.

input?: string | ArrayBufferView

Property Value

string | ArrayBufferView

maxBuffer

The maximum number of bytes allowed on stdout or stderr.

maxBuffer?: number

Property Value

number

stdio

Standard input, output, and error mappings.

stdio?: StdioOptions

Property Value

StdioOptions

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