Interfaz: Docker

Desde

0.2.0

Propiedades

cli

• Readonly cli: DockerCommand

También puedes ejecutar directamente el binario de Docker.

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

Salida:

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

Para mayor comodidad, el objeto de resultado del comando también tiene métodos para analizarlo fácilmente según el formato de salida. Consulta ExecResult en su lugar.

Transmite en flujo (stream) la salida resultante de la ejecución de un comando de Docker. Es útil cuando la salida del comando es demasiado larga o necesitas obtener la salida en forma de flujo.

await ddClient.docker.cli.exec("logs", ["-f", "..."], {
  stream: {
    onOutput(data): void {
      // Como podemos recibir tanto `stdout` como `stderr`, los envolvemos en un objeto JSON
      JSON.stringify(
        {
          stdout: data.stdout,
          stderr: data.stderr,
        },
        null,
        "  ",
      );
    },
    onError(error: any): void {
      console.error(error);
    },
    onClose(exitCode: number): void {
      console.log("onClose con código de salida " + exitCode);
    },
  },
});

Métodos

listContainers

▸ listContainers(options?): Promise<unknown>

Obtiene la lista de contenedores en ejecución (igual que docker ps).

Por defecto, esto no enumerará los contenedores detenidos. Puedes usar la opción {"all": true} para enumerar todos los contenedores en ejecución y detenidos.

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

Parámetros

Devuelve

Promise<unknown>

listImages

▸ listImages(options?): Promise<unknown>

Obtiene la lista de imágenes de contenedor locales

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

Parámetros

Devuelve

Promise<unknown>