接口: Docker

目录

Since

0.2.0

属性

cli

• Readonly cli: DockerCommand

你也可以直接执行Docker二进制文件。

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

输出:

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

为了方便起见，命令结果对象还具有根据输出格式轻松解析它的方法。请参阅 ExecResult。

将Docker命令执行的输出作为流进行传输。 当命令的输出过长，或者需要将输出作为流获取时，这非常有用。

await ddClient.docker.cli.exec("logs", ["-f", "..."], {
  stream: {
    onOutput(data): void {
        // As we can receive both `stdout` and `stderr`, we wrap them in a JSON object
        JSON.stringify(
          {
            stdout: data.stdout,
            stderr: data.stderr,
          },
          null,
          "  "
        );
    },
    onError(error: any): void {
      console.error(error);
    },
    onClose(exitCode: number): void {
      console.log("onClose with exit code " + exitCode);
    },
  },
});

方法

listContainers

▸ listContainers(options?): Promise<unknown>

获取正在运行的容器列表（与docker ps相同）。

默认情况下，这不会列出已停止的容器。 您可以使用选项 {"all": true} 来列出所有正在运行和已停止的容器。

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

参数

NameTypeDescription
options?any(Optional). A JSON like { "all": true, "limit": 10, "size": true, "filters": JSON.stringify({ status: ["exited"] }), } For more information about the different properties see Docker API 端点文档.

返回

Promise<unknown>

listImages

▸ listImages(options?): Promise<unknown>

获取本地容器镜像列表

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

参数

NameTypeDescription
options?any(Optional). A JSON like { "all": true, "filters": JSON.stringify({ dangling: ["true"] }), "digests": true * } For more information about the different properties see Docker API 端点文档.

返回

Promise<unknown>