@azure/core-process package

Klasser

ProcessError

Ett fel som uppstår när en process löses eller exekveras. Den infångade utgången är icke-uppräknbar så vanlig loggning och serialisering exponerar den inte av misstag.

Gränssnitt

ExecFileOptions	Alternativ för execFile.
ExecFileOptionsWithBufferEncoding	Bufferkodningsalternativ för execFile.
ExecFileOptionsWithStringEncoding	Strängkodningsalternativ för execFile.
ExecFileResult	Buffrad utdata från execFile.
ProcessErrorOptions	Strukturerade detaljer för en ProcessError.
ProcessOptions	Alternativ som delas av säkra processoperationer.
ResolveExecutableOptions	Alternativ som används vid lösning av en körbar fil.
SpawnOptions	Alternativ för spawn.
SpawnSyncOptions	Alternativ för spawnSync.
SpawnSyncOptionsWithBufferEncoding	Bufferkodningsalternativ för spawnSync.
SpawnSyncOptionsWithStringEncoding	Strängkodningsalternativ för spawnSync.

Funktioner

execFile(string, readonly string[])	Kör en process till slut och buffrar dess utdata.
execFile(string, undefined | (readonly string[]), ExecFileOptionsWithBufferEncoding)	Kör en process till slut och buffrar dess utdata.
execFile(string, undefined | (readonly string[]), ExecFileOptionsWithStringEncoding)	Kör en process till slut och buffrar dess utdata.
execFile(string, readonly string[], ExecFileOptions)	Kör en process till slut och buffrar dess utdata.
isProcessError(unknown)	Kontrollerar om ett okänt värde är ett ProcessError.
resolveExecutable(string, ResolveExecutableOptions)	Löser en exekverbar fil med en explicit arbetskatalog och miljö.
spawn(string, readonly string[], SpawnOptions)	Startar en process utan att använda ett omgivande operativsystemskal.
spawnSync(string, undefined | (readonly string[]), SpawnSyncOptionsWithStringEncoding)	Startar en process synkront utan att använda ett omgivande operativsystemskal.
spawnSync(string, readonly string[], SpawnSyncOptionsWithBufferEncoding)	Startar en process synkront utan att använda ett omgivande operativsystemskal.
spawnSync(string, undefined | (readonly string[]), SpawnSyncOptions)	Startar en process synkront utan att använda ett omgivande operativsystemskal.

Funktionsinformation

execFile(string, readonly string[])

Kör en process till slut och buffrar dess utdata.

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

Parametrar

command

string

Körbar fil namn eller sökväg.

args

readonly string[]

Argument överförs till den exekverbara filen.

Returer

Promise<ExecFileResult<string>>

Buffrad standardutgång och standardfel.

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

Kör en process till slut och buffrar dess utdata.

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

Parametrar

command

string

Körbar fil namn eller sökväg.

args

undefined | (readonly string[])

Argument överförs till den exekverbara filen.

options

ExecFileOptionsWithBufferEncoding

Processa alternativ.

Returer

Promise<ExecFileResult<Buffer>>

Buffrad standardutgång och standardfel.

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

Kör en process till slut och buffrar dess utdata.

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

Parametrar

command

string

Körbar fil namn eller sökväg.

args

undefined | (readonly string[])

Argument överförs till den exekverbara filen.

options

ExecFileOptionsWithStringEncoding

Processa alternativ.

Returer

Promise<ExecFileResult<string>>

Buffrad standardutgång och standardfel.

execFile(string, readonly string[], ExecFileOptions)

Kör en process till slut och buffrar dess utdata.

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

Parametrar

command

string

Körbar fil namn eller sökväg.

args

readonly string[]

Argument överförs till den exekverbara filen.

options

ExecFileOptions

Processa alternativ.

Returer

Promise<ExecFileResult<string | Buffer>>

Buffrad standardutgång och standardfel.

isProcessError(unknown)

Kontrollerar om ett okänt värde är ett ProcessError.

function isProcessError(error: unknown): error

Parametrar

error

unknown

Värdet som ska kontrolleras.

Returer

error

Om värdet är ett processfel.

resolveExecutable(string, ResolveExecutableOptions)

Löser en exekverbar fil med en explicit arbetskatalog och miljö.

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

Parametrar

command

string

Körbar fil namn eller sökväg. Den får inte innehålla argument.

options

ResolveExecutableOptions

Lösningsalternativ.

Returer

string | undefined

Den absoluta körbara sökvägen, eller undefined när ingen stödd fil hittas.

spawn(string, readonly string[], SpawnOptions)

Startar en process utan att använda ett omgivande operativsystemskal.

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

Parametrar

command

string

Körbar fil namn eller sökväg.

args

readonly string[]

Argument överförs till den exekverbara filen.

options

SpawnOptions

Processa alternativ.

Returer

childProcess.ChildProcess

Den påbörjade barnprocessen.

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

Startar en process synkront utan att använda ett omgivande operativsystemskal.

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

Parametrar

command

string

Körbar fil namn eller sökväg.

args

undefined | (readonly string[])

Argument överförs till den exekverbara filen.

options

SpawnSyncOptionsWithStringEncoding

Processa alternativ.

Returer

childProcess.SpawnSyncReturns<string>

Den synkrona processen resulterar.

spawnSync(string, readonly string[], SpawnSyncOptionsWithBufferEncoding)

Startar en process synkront utan att använda ett omgivande operativsystemskal.

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

Parametrar

command

string

Körbar fil namn eller sökväg.

args

readonly string[]

Argument överförs till den exekverbara filen.

options

SpawnSyncOptionsWithBufferEncoding

Processa alternativ.

Returer

childProcess.SpawnSyncReturns<Buffer>

Den synkrona processen resulterar.

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

Startar en process synkront utan att använda ett omgivande operativsystemskal.

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

Parametrar

command

string

Körbar fil namn eller sökväg.

args

undefined | (readonly string[])

Argument överförs till den exekverbara filen.

options

SpawnSyncOptions

Processa alternativ.

Returer

childProcess.SpawnSyncReturns<string | Buffer>

Den synkrona processen resulterar.