@azure/core-process package

Classes

ProcessError

Um erro surgido durante a resolução ou execução de um processo. A saída capturada é não enumerável, pelo que o registo e a serialização ordinários não a expõem acidentalmente.

Interfaces

ExecFileOptions	Opções para execFile.
ExecFileOptionsWithBufferEncoding	Opções de codificação de buffer para execFile.
ExecFileOptionsWithStringEncoding	Opções de codificação de strings para execFile.
ExecFileResult	Saída em buffer do execFile.
ProcessErrorOptions	Detalhes estruturados para um ProcessoErro.
ProcessOptions	Opções partilhadas por operações de processos seguros.
ResolveExecutableOptions	Opções usadas na resolução de um executável.
SpawnOptions	Opções para spawn.
SpawnSyncOptions	Opções para spawnSync.
SpawnSyncOptionsWithBufferEncoding	Opções de codificação de buffer para spawnSync.
SpawnSyncOptionsWithStringEncoding	Opções de codificação de strings para spawnSync.

Funções

execFile(string, readonly string[])	Executa um processo até à conclusão e armazena a sua saída em buffer.
execFile(string, undefined | (readonly string[]), ExecFileOptionsWithBufferEncoding)	Executa um processo até à conclusão e armazena a sua saída em buffer.
execFile(string, undefined | (readonly string[]), ExecFileOptionsWithStringEncoding)	Executa um processo até à conclusão e armazena a sua saída em buffer.
execFile(string, readonly string[], ExecFileOptions)	Executa um processo até à conclusão e armazena a sua saída em buffer.
isProcessError(unknown)	Verifica se um valor desconhecido é um ProcessError.
resolveExecutable(string, ResolveExecutableOptions)	Resolve um executável usando um diretório e ambiente de trabalho explícitos.
spawn(string, readonly string[], SpawnOptions)	Inicia um processo sem usar um shell ambiente do sistema operativo.
spawnSync(string, undefined | (readonly string[]), SpawnSyncOptionsWithStringEncoding)	Inicia um processo de forma síncrona sem usar um shell de sistema operativo ambiente.
spawnSync(string, readonly string[], SpawnSyncOptionsWithBufferEncoding)	Inicia um processo de forma síncrona sem usar um shell de sistema operativo ambiente.
spawnSync(string, undefined | (readonly string[]), SpawnSyncOptions)	Inicia um processo de forma síncrona sem usar um shell de sistema operativo ambiente.

Detalhes de Função

execFile(string, readonly string[])

Executa um processo até à conclusão e armazena a sua saída em buffer.

function execFile(command: string, args?: readonly string[]): Promise<ExecFileResult<string>>

Parâmetros

command

string

O nome ou caminho do executável.

args

readonly string[]

Os argumentos passavam para o executável.

Devoluções

Promise<ExecFileResult<string>>

Saída padrão em buffer e erro padrão.

execFile(string, undefined | (readonly string[]), ExecFileOptionsWithBufferEncoding)

Executa um processo até à conclusão e armazena a sua saída em buffer.

function execFile(command: string, args: undefined | (readonly string[]), options: ExecFileOptionsWithBufferEncoding): Promise<ExecFileResult<Buffer>>

Parâmetros

command

string

O nome ou caminho do executável.

args

undefined | (readonly string[])

Os argumentos passavam para o executável.

options

ExecFileOptionsWithBufferEncoding

Opções de processo.

Devoluções

Promise<ExecFileResult<Buffer>>

Saída padrão em buffer e erro padrão.

execFile(string, undefined | (readonly string[]), ExecFileOptionsWithStringEncoding)

Executa um processo até à conclusão e armazena a sua saída em buffer.

function execFile(command: string, args: undefined | (readonly string[]), options: ExecFileOptionsWithStringEncoding): Promise<ExecFileResult<string>>

Parâmetros

command

string

O nome ou caminho do executável.

args

undefined | (readonly string[])

Os argumentos passavam para o executável.

options

ExecFileOptionsWithStringEncoding

Opções de processo.

Devoluções

Promise<ExecFileResult<string>>

Saída padrão em buffer e erro padrão.

execFile(string, readonly string[], ExecFileOptions)

Executa um processo até à conclusão e armazena a sua saída em buffer.

function execFile(command: string, args?: readonly string[], options?: ExecFileOptions): Promise<ExecFileResult<string | Buffer>>

Parâmetros

command

string

O nome ou caminho do executável.

args

readonly string[]

Os argumentos passavam para o executável.

options

ExecFileOptions

Opções de processo.

Devoluções

Promise<ExecFileResult<string | Buffer>>

Saída padrão em buffer e erro padrão.

isProcessError(unknown)

Verifica se um valor desconhecido é um ProcessError.

function isProcessError(error: unknown): error

Parâmetros

error

unknown

O valor a verificar.

Devoluções

error

Se o valor é um erro de processo.

resolveExecutable(string, ResolveExecutableOptions)

Resolve um executável usando um diretório e ambiente de trabalho explícitos.

function resolveExecutable(command: string, options?: ResolveExecutableOptions): string | undefined

Parâmetros

command

string

O nome ou caminho do executável. Não deve conter argumentos.

options

ResolveExecutableOptions

Opções de resolução.

Devoluções

string | undefined

O caminho executável absoluto, ou undefined quando não é encontrado nenhum ficheiro suportado.

spawn(string, readonly string[], SpawnOptions)

Inicia um processo sem usar um shell ambiente do sistema operativo.

function spawn(command: string, args?: readonly string[], options?: SpawnOptions): childProcess.ChildProcess

Parâmetros

command

string

O nome ou caminho do executável.

args

readonly string[]

Os argumentos passavam para o executável.

options

SpawnOptions

Opções de processo.

Devoluções

childProcess.ChildProcess

O processo de criança iniciada.

spawnSync(string, undefined | (readonly string[]), SpawnSyncOptionsWithStringEncoding)

Inicia um processo de forma síncrona sem usar um shell de sistema operativo ambiente.

function spawnSync(command: string, args: undefined | (readonly string[]), options: SpawnSyncOptionsWithStringEncoding): childProcess.SpawnSyncReturns<string>

Parâmetros

command

string

O nome ou caminho do executável.

args

undefined | (readonly string[])

Os argumentos passavam para o executável.

options

SpawnSyncOptionsWithStringEncoding

Opções de processo.

Devoluções

childProcess.SpawnSyncReturns<string>

O resultado do processo síncrono.

spawnSync(string, readonly string[], SpawnSyncOptionsWithBufferEncoding)

Inicia um processo de forma síncrona sem usar um shell de sistema operativo ambiente.

function spawnSync(command: string, args?: readonly string[], options?: SpawnSyncOptionsWithBufferEncoding): childProcess.SpawnSyncReturns<Buffer>

Parâmetros

command

string

O nome ou caminho do executável.

args

readonly string[]

Os argumentos passavam para o executável.

options

SpawnSyncOptionsWithBufferEncoding

Opções de processo.

Devoluções

childProcess.SpawnSyncReturns<Buffer>

O resultado do processo síncrono.

spawnSync(string, undefined | (readonly string[]), SpawnSyncOptions)

Inicia um processo de forma síncrona sem usar um shell de sistema operativo ambiente.

function spawnSync(command: string, args: undefined | (readonly string[]), options: SpawnSyncOptions): childProcess.SpawnSyncReturns<string | Buffer>

Parâmetros

command

string

O nome ou caminho do executável.

args

undefined | (readonly string[])

Os argumentos passavam para o executável.

options

SpawnSyncOptions

Opções de processo.

Devoluções

childProcess.SpawnSyncReturns<string | Buffer>

O resultado do processo síncrono.