@azure/core-process package

Klasy

ProcessError

Błąd pojawiający się podczas rozwiązywania lub wykonywania procesu.

Przechwycony wynik jest niepoliczalny, więc zwykłe logowanie i serializacja nie ujawniają go przypadkowo.

Interfejsy

ExecFileOptions

Opcje dla execFile.

ExecFileOptionsWithBufferEncoding

Opcje kodowania bufora dla execFile.

ExecFileOptionsWithStringEncoding

Opcje kodowania ciągów znaków dla execFile.

ExecFileResult

Buforowane wyjście z pliku execFile.

ProcessErrorOptions

Szczegóły strukturalne dla ProcessError.

ProcessOptions

Opcje wspólne dla bezpiecznych operacji procesowych.

ResolveExecutableOptions

Opcje używane podczas rozwiązywania pliku wykonywalnego.

SpawnOptions

Opcje pojawiania się.

SpawnSyncOptions

Opcje spawnSync.

SpawnSyncOptionsWithBufferEncoding

Opcje kodowania bufora dla spawnSync.

SpawnSyncOptionsWithStringEncoding

Opcje kodowania ciągów znaków dla spawnSync.

Funkcje

execFile(string, readonly string[])

Uruchamia proces do końca i buforuje jego wyjście.

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

Uruchamia proces do końca i buforuje jego wyjście.

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

Uruchamia proces do końca i buforuje jego wyjście.

execFile(string, readonly string[], ExecFileOptions)

Uruchamia proces do końca i buforuje jego wyjście.

isProcessError(unknown)

Sprawdza, czy nieznana wartość jest błędem procesu.

resolveExecutable(string, ResolveExecutableOptions)

Rozwiązuje plik wykonywalny za pomocą jawnego katalogu roboczego i środowiska.

spawn(string, readonly string[], SpawnOptions)

Uruchamia proces bez użycia powłoki systemu operacyjnego otoczenia.

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

Uruchamia proces synchronicznie bez użycia powłoki systemu operacyjnego w otoczeniu.

spawnSync(string, readonly string[], SpawnSyncOptionsWithBufferEncoding)

Uruchamia proces synchronicznie bez użycia powłoki systemu operacyjnego w otoczeniu.

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

Uruchamia proces synchronicznie bez użycia powłoki systemu operacyjnego w otoczeniu.

Szczegóły funkcji

execFile(string, readonly string[])

Uruchamia proces do końca i buforuje jego wyjście.

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

Parametry

command

string

Nazwa lub ścieżka wykonywalna.

args

readonly string[]

Argumenty przekazywane do pliku wykonalnego.

Zwraca

Promise<ExecFileResult<string>>

Buforowane wyjście standardowe i błąd standardowy.

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

Uruchamia proces do końca i buforuje jego wyjście.

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

Parametry

command

string

Nazwa lub ścieżka wykonywalna.

args

undefined | (readonly string[])

Argumenty przekazywane do pliku wykonalnego.

options
ExecFileOptionsWithBufferEncoding

Opcje procesu.

Zwraca

Promise<ExecFileResult<Buffer>>

Buforowane wyjście standardowe i błąd standardowy.

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

Uruchamia proces do końca i buforuje jego wyjście.

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

Parametry

command

string

Nazwa lub ścieżka wykonywalna.

args

undefined | (readonly string[])

Argumenty przekazywane do pliku wykonalnego.

options
ExecFileOptionsWithStringEncoding

Opcje procesu.

Zwraca

Promise<ExecFileResult<string>>

Buforowane wyjście standardowe i błąd standardowy.

execFile(string, readonly string[], ExecFileOptions)

Uruchamia proces do końca i buforuje jego wyjście.

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

Parametry

command

string

Nazwa lub ścieżka wykonywalna.

args

readonly string[]

Argumenty przekazywane do pliku wykonalnego.

options
ExecFileOptions

Opcje procesu.

Zwraca

Promise<ExecFileResult<string | Buffer>>

Buforowane wyjście standardowe i błąd standardowy.

isProcessError(unknown)

Sprawdza, czy nieznana wartość jest błędem procesu.

function isProcessError(error: unknown): error

Parametry

error

unknown

Wartość do sprawdzenia.

Zwraca

error

Czy wartość jest błędem procesu.

resolveExecutable(string, ResolveExecutableOptions)

Rozwiązuje plik wykonywalny za pomocą jawnego katalogu roboczego i środowiska.

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

Parametry

command

string

Nazwa lub ścieżka wykonywalna. Nie może zawierać argumentów.

options
ResolveExecutableOptions

Opcje rozdzielczości.

Zwraca

string | undefined

Absolutna ścieżka wykonywalna, czyli undefined gdy nie ma wspieranego pliku.

spawn(string, readonly string[], SpawnOptions)

Uruchamia proces bez użycia powłoki systemu operacyjnego otoczenia.

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

Parametry

command

string

Nazwa lub ścieżka wykonywalna.

args

readonly string[]

Argumenty przekazywane do pliku wykonalnego.

options
SpawnOptions

Opcje procesu.

Zwraca

childProcess.ChildProcess

Proces rozpoczęcia dziecka.

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

Uruchamia proces synchronicznie bez użycia powłoki systemu operacyjnego w otoczeniu.

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

Parametry

command

string

Nazwa lub ścieżka wykonywalna.

args

undefined | (readonly string[])

Argumenty przekazywane do pliku wykonalnego.

options
SpawnSyncOptionsWithStringEncoding

Opcje procesu.

Zwraca

childProcess.SpawnSyncReturns<string>

Efekt procesu synchronicznego.

spawnSync(string, readonly string[], SpawnSyncOptionsWithBufferEncoding)

Uruchamia proces synchronicznie bez użycia powłoki systemu operacyjnego w otoczeniu.

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

Parametry

command

string

Nazwa lub ścieżka wykonywalna.

args

readonly string[]

Argumenty przekazywane do pliku wykonalnego.

options
SpawnSyncOptionsWithBufferEncoding

Opcje procesu.

Zwraca

childProcess.SpawnSyncReturns<Buffer>

Efekt procesu synchronicznego.

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

Uruchamia proces synchronicznie bez użycia powłoki systemu operacyjnego w otoczeniu.

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

Parametry

command

string

Nazwa lub ścieżka wykonywalna.

args

undefined | (readonly string[])

Argumenty przekazywane do pliku wykonalnego.

options
SpawnSyncOptions

Opcje procesu.

Zwraca

childProcess.SpawnSyncReturns<string | Buffer>

Efekt procesu synchronicznego.