@azure/core-process package

Classes

ProcessError

Une erreur générée lors de la résolution ou de l’exécution d’un processus. La sortie capturée est non énumérable, donc la journalisation ordinaire et la sérialisation ne l’exposent pas accidentellement.

Interfaces

ExecFileOptions	Options pour execFile.
ExecFileOptionsWithBufferEncoding	Options d’encodage de tampon pour execFile.
ExecFileOptionsWithStringEncoding	Options d’encodage de chaînes pour execFile.
ExecFileResult	Sortie tampon depuis execFile.
ProcessErrorOptions	Détails structurés pour un ProcessError.
ProcessOptions	Options partagées par des opérations de processus sécurisées.
ResolveExecutableOptions	Options utilisées lors de la résolution d’un exécutable.
SpawnOptions	Options pour le spawn.
SpawnSyncOptions	Options pour spawnSync.
SpawnSyncOptionsWithBufferEncoding	Options d’encodage de tampon pour spawnSync.
SpawnSyncOptionsWithStringEncoding	Options de codage de chaînes pour spawnSync.

Functions

execFile(string, readonly string[])	Exécute un processus jusqu’à la fin et met en mémoire tampon sa sortie.
execFile(string, undefined | (readonly string[]), ExecFileOptionsWithBufferEncoding)	Exécute un processus jusqu’à la fin et met en mémoire tampon sa sortie.
execFile(string, undefined | (readonly string[]), ExecFileOptionsWithStringEncoding)	Exécute un processus jusqu’à la fin et met en mémoire tampon sa sortie.
execFile(string, readonly string[], ExecFileOptions)	Exécute un processus jusqu’à la fin et met en mémoire tampon sa sortie.
isProcessError(unknown)	Vérifie si une valeur inconnue est une Ereur de processus.
resolveExecutable(string, ResolveExecutableOptions)	Résout un exécutable en utilisant un répertoire et un environnement de travail explicites.
spawn(string, readonly string[], SpawnOptions)	Démarre un processus sans utiliser un shell de système d’exploitation ambiant.
spawnSync(string, undefined | (readonly string[]), SpawnSyncOptionsWithStringEncoding)	Démarre un processus de façon synchrone sans utiliser un shell de système d’exploitation ambiant.
spawnSync(string, readonly string[], SpawnSyncOptionsWithBufferEncoding)	Démarre un processus de façon synchrone sans utiliser un shell de système d’exploitation ambiant.
spawnSync(string, undefined | (readonly string[]), SpawnSyncOptions)	Démarre un processus de façon synchrone sans utiliser un shell de système d’exploitation ambiant.

Informations relatives à la fonction

execFile(string, readonly string[])

Exécute un processus jusqu’à la fin et met en mémoire tampon sa sortie.

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

Paramètres

command

string

Le nom ou le chemin de l’exécutable.

args

readonly string[]

Les arguments passaient à l’exécutable.

Retours

Promise<ExecFileResult<string>>

Sortie standard tamponnée et erreur standard.

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

Exécute un processus jusqu’à la fin et met en mémoire tampon sa sortie.

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

Paramètres

command

string

Le nom ou le chemin de l’exécutable.

args

undefined | (readonly string[])

Les arguments passaient à l’exécutable.

options

ExecFileOptionsWithBufferEncoding

Options de processus.

Retours

Promise<ExecFileResult<Buffer>>

Sortie standard tamponnée et erreur standard.

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

Exécute un processus jusqu’à la fin et met en mémoire tampon sa sortie.

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

Paramètres

command

string

Le nom ou le chemin de l’exécutable.

args

undefined | (readonly string[])

Les arguments passaient à l’exécutable.

options

ExecFileOptionsWithStringEncoding

Options de processus.

Retours

Promise<ExecFileResult<string>>

Sortie standard tamponnée et erreur standard.

execFile(string, readonly string[], ExecFileOptions)

Exécute un processus jusqu’à la fin et met en mémoire tampon sa sortie.

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

Paramètres

command

string

Le nom ou le chemin de l’exécutable.

args

readonly string[]

Les arguments passaient à l’exécutable.

options

ExecFileOptions

Options de processus.

Retours

Promise<ExecFileResult<string | Buffer>>

Sortie standard tamponnée et erreur standard.

isProcessError(unknown)

Vérifie si une valeur inconnue est une Ereur de processus.

function isProcessError(error: unknown): error

Paramètres

error

unknown

Valeur à vérifier.

Retours

error

Que la valeur soit une erreur de processus.

resolveExecutable(string, ResolveExecutableOptions)

Résout un exécutable en utilisant un répertoire et un environnement de travail explicites.

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

Paramètres

command

string

Le nom ou le chemin de l’exécutable. Il ne doit pas contenir d’arguments.

options

ResolveExecutableOptions

Options de résolution.

Retours

string | undefined

Le chemin exécutable absolu, ou undefined lorsqu’aucun fichier pris en charge n’est trouvé.

spawn(string, readonly string[], SpawnOptions)

Démarre un processus sans utiliser un shell de système d’exploitation ambiant.

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

Paramètres

command

string

Le nom ou le chemin de l’exécutable.

args

readonly string[]

Les arguments passaient à l’exécutable.

options

SpawnOptions

Options de processus.

Retours

childProcess.ChildProcess

Le processus de démarrage de l’enfant.

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

Démarre un processus de façon synchrone sans utiliser un shell de système d’exploitation ambiant.

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

Paramètres

command

string

Le nom ou le chemin de l’exécutable.

args

undefined | (readonly string[])

Les arguments passaient à l’exécutable.

options

SpawnSyncOptionsWithStringEncoding

Options de processus.

Retours

childProcess.SpawnSyncReturns<string>

Le résultat du processus synchrone.

spawnSync(string, readonly string[], SpawnSyncOptionsWithBufferEncoding)

Démarre un processus de façon synchrone sans utiliser un shell de système d’exploitation ambiant.

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

Paramètres

command

string

Le nom ou le chemin de l’exécutable.

args

readonly string[]

Les arguments passaient à l’exécutable.

options

SpawnSyncOptionsWithBufferEncoding

Options de processus.

Retours

childProcess.SpawnSyncReturns<Buffer>

Le résultat du processus synchrone.

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

Démarre un processus de façon synchrone sans utiliser un shell de système d’exploitation ambiant.

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

Paramètres

command

string

Le nom ou le chemin de l’exécutable.

args

undefined | (readonly string[])

Les arguments passaient à l’exécutable.

options

SpawnSyncOptions

Options de processus.

Retours

childProcess.SpawnSyncReturns<string | Buffer>

Le résultat du processus synchrone.