Interface : Docker

Depuis

0.2.0

Propriétés

cli

• Readonly cli: DockerCommand

Vous pouvez aussi exécuter directement le binaire Docker.

const output = await ddClient.docker.cli.exec("volume", [
  "ls",
  "--filter",
  "dangling=true"
]);

Sortie :

{
  "stderr": "...",
  "stdout": "..."
}

Par commodité, l'objet de résultat de commande a aussi des méthodes pour facilement l'analyser selon le format de sortie. Voir ExecResult à la place.

Diffuse la sortie comme résultat de l'exécution d'une commande Docker. C'est utile quand la sortie de la commande est trop longue, ou que vous devez obtenir la sortie comme un flux.

await ddClient.docker.cli.exec("logs", ["-f", "..."], {
  stream: {
    onOutput(data): void {
        // Comme nous pouvons recevoir à la fois `stdout` et `stderr`, nous les enveloppons dans un objet JSON
        JSON.stringify(
          {
            stdout: data.stdout,
            stderr: data.stderr,
          },
          null,
          "  "
        );
    },
    onError(error: any): void {
      console.error(error);
    },
    onClose(exitCode: number): void {
      console.log("onClose avec le code de sortie " + exitCode);
    },
  },
});

Méthodes

listContainers

▸ listContainers(options?): Promise<unknown>

Obtenir la liste des conteneurs en cours d'exécution (identique à docker ps).

Par défaut, cela ne listera pas les conteneurs arrêtés. Vous pouvez utiliser l'option {"all": true} pour lister tous les conteneurs en cours d'exécution et arrêtés.

const containers = await ddClient.docker.listContainers();

Paramètres

Retourne

Promise<unknown>

listImages

▸ listImages(options?): Promise<unknown>

Obtenir la liste des images de conteneurs locales

const images = await ddClient.docker.listImages();

Paramètres

Retourne

Promise<unknown>