⚠️ Traduction non officielle - Cette documentation est une traduction communautaire non officielle de Docker.

Interface : ExecStreamOptions

Depuis

0.2.2

Propriétés

onOutput

Optional onOutput: (data: { stdout: string ; stderr?: undefined } | { stdout?: undefined ; stderr: string }) => void

Déclaration de type

▸ (data): void

Invoqué lors de la réception de sortie de l'exécution de commande. Par défaut, la sortie est divisée en chunks à des frontières arbitraires. Si vous préférez que la sortie soit divisée en lignes complètes, définissez splitOutputLines à true. Le callback est alors invoqué une fois pour chaque ligne.

Depuis

0.2.0

Paramètres
Nom Type Description
data { stdout: string; stderr?: undefined } | { stdout?: undefined; stderr: string } Contenu de sortie. Peut inclure soit une chaîne stdout, soit une chaîne stderr, une à la fois.
Retourne

void


onError

Optional onError: (error: any) => void

Déclaration de type

▸ (error): void

Invoqué pour signaler une erreur si la commande exécutée a des erreurs.

Paramètres
Nom Type Description
error any L'erreur survenant dans la commande exécutée
Retourne

void


onClose

Optional onClose: (exitCode: number) => void

Déclaration de type

▸ (exitCode): void

Invoqué quand le processus se termine.

Paramètres
Nom Type Description
exitCode number Le code de sortie du processus
Retourne

void


splitOutputLines

Optional Readonly splitOutputLines: boolean

Spécifie le comportement d'invocation d'onOutput(data). Sortie brute par défaut, divisant la sortie à toute position. Si défini à true, onOutput sera invoqué une fois pour chaque ligne.