@azure/core-process package

Classi

ProcessError

Un errore viene generato durante la risoluzione o l'esecuzione di un processo. L'output catturato è non enumerabile, quindi il log ordinario e la serializzazione non lo espongono accidentalmente.

Interfacce

ExecFileOptions	Opzioni per execFile.
ExecFileOptionsWithBufferEncoding	Opzioni di codifica del buffer per execFile.
ExecFileOptionsWithStringEncoding	Opzioni di codifica delle stringhe per execFile.
ExecFileResult	Output bufferizzato da execFile.
ProcessErrorOptions	Dettagli strutturati per un ProcessError.
ProcessOptions	Opzioni condivise da operazioni di processo sicuro.
ResolveExecutableOptions	Opzioni utilizzate durante la risoluzione di un eseguibile.
SpawnOptions	Opzioni per lo spawn.
SpawnSyncOptions	Opzioni per spawnSync.
SpawnSyncOptionsWithBufferEncoding	Opzioni di codifica del buffer per spawnSync.
SpawnSyncOptionsWithStringEncoding	Opzioni di codifica stringa per spawnSync.

Funzioni

execFile(string, readonly string[])	Esegue un processo fino al completamento e ne buffizza l'output.
execFile(string, undefined | (readonly string[]), ExecFileOptionsWithBufferEncoding)	Esegue un processo fino al completamento e ne buffizza l'output.
execFile(string, undefined | (readonly string[]), ExecFileOptionsWithStringEncoding)	Esegue un processo fino al completamento e ne buffizza l'output.
execFile(string, readonly string[], ExecFileOptions)	Esegue un processo fino al completamento e ne buffizza l'output.
isProcessError(unknown)	Controlla se un valore sconosciuto è un Errore di Processo.
resolveExecutable(string, ResolveExecutableOptions)	Risolve un eseguibile utilizzando una directory e un ambiente di lavoro espliciti.
spawn(string, readonly string[], SpawnOptions)	Avvia un processo senza utilizzare una shell ambient del sistema operativo.
spawnSync(string, undefined | (readonly string[]), SpawnSyncOptionsWithStringEncoding)	Avvia un processo in modo sincrono senza utilizzare una shell ambient del sistema operativo.
spawnSync(string, readonly string[], SpawnSyncOptionsWithBufferEncoding)	Avvia un processo in modo sincrono senza utilizzare una shell ambient del sistema operativo.
spawnSync(string, undefined | (readonly string[]), SpawnSyncOptions)	Avvia un processo in modo sincrono senza utilizzare una shell ambient del sistema operativo.

Dettagli funzione

execFile(string, readonly string[])

Esegue un processo fino al completamento e ne buffizza l'output.

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

Parametri

command

string

Il nome o percorso dell'eseguibile.

args

readonly string[]

Gli argomenti passavano all'esecutivo.

Valori restituiti

Promise<ExecFileResult<string>>

Uscita standard bufferizzata e errore standard.

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

Esegue un processo fino al completamento e ne buffizza l'output.

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

Parametri

command

string

Il nome o percorso dell'eseguibile.

args

undefined | (readonly string[])

Gli argomenti passavano all'esecutivo.

options

ExecFileOptionsWithBufferEncoding

Opzioni di processo.

Valori restituiti

Promise<ExecFileResult<Buffer>>

Uscita standard bufferizzata e errore standard.

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

Esegue un processo fino al completamento e ne buffizza l'output.

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

Parametri

command

string

Il nome o percorso dell'eseguibile.

args

undefined | (readonly string[])

Gli argomenti passavano all'esecutivo.

options

ExecFileOptionsWithStringEncoding

Opzioni di processo.

Valori restituiti

Promise<ExecFileResult<string>>

Uscita standard bufferizzata e errore standard.

execFile(string, readonly string[], ExecFileOptions)

Esegue un processo fino al completamento e ne buffizza l'output.

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

Parametri

command

string

Il nome o percorso dell'eseguibile.

args

readonly string[]

Gli argomenti passavano all'esecutivo.

options

ExecFileOptions

Opzioni di processo.

Valori restituiti

Promise<ExecFileResult<string | Buffer>>

Uscita standard bufferizzata e errore standard.

isProcessError(unknown)

Controlla se un valore sconosciuto è un Errore di Processo.

function isProcessError(error: unknown): error

Parametri

error

unknown

Valore da controllare.

Valori restituiti

error

Se il valore sia un errore di processo.

resolveExecutable(string, ResolveExecutableOptions)

Risolve un eseguibile utilizzando una directory e un ambiente di lavoro espliciti.

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

Parametri

command

string

Il nome o percorso dell'eseguibile. Non deve contenere argomentazioni.

options

ResolveExecutableOptions

Opzioni di risoluzione.

Valori restituiti

string | undefined

Il percorso eseguibile assoluto, o undefined quando non viene trovato alcun file supportato.

spawn(string, readonly string[], SpawnOptions)

Avvia un processo senza utilizzare una shell ambient del sistema operativo.

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

Parametri

command

string

Il nome o percorso dell'eseguibile.

args

readonly string[]

Gli argomenti passavano all'esecutivo.

options

SpawnOptions

Opzioni di processo.

Valori restituiti

childProcess.ChildProcess

Il processo di inizio bambino.

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

Avvia un processo in modo sincrono senza utilizzare una shell ambient del sistema operativo.

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

Parametri

command

string

Il nome o percorso dell'eseguibile.

args

undefined | (readonly string[])

Gli argomenti passavano all'esecutivo.

options

SpawnSyncOptionsWithStringEncoding

Opzioni di processo.

Valori restituiti

childProcess.SpawnSyncReturns<string>

Il risultato del processo sincrono.

spawnSync(string, readonly string[], SpawnSyncOptionsWithBufferEncoding)

Avvia un processo in modo sincrono senza utilizzare una shell ambient del sistema operativo.

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

Parametri

command

string

Il nome o percorso dell'eseguibile.

args

readonly string[]

Gli argomenti passavano all'esecutivo.

options

SpawnSyncOptionsWithBufferEncoding

Opzioni di processo.

Valori restituiti

childProcess.SpawnSyncReturns<Buffer>

Il risultato del processo sincrono.

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

Avvia un processo in modo sincrono senza utilizzare una shell ambient del sistema operativo.

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

Parametri

command

string

Il nome o percorso dell'eseguibile.

args

undefined | (readonly string[])

Gli argomenti passavano all'esecutivo.

options

SpawnSyncOptions

Opzioni di processo.

Valori restituiti

childProcess.SpawnSyncReturns<string | Buffer>

Il risultato del processo sincrono.