介面：Docker

目錄

自

0.2.0

屬性

cli

• 唯讀 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();

參數

名稱類型說明
options?任何（選用）。類似 JSON 的 { "all": true, "limit": 10, "size": true, "filters": JSON.stringify({ status: ["exited"] }), } 如需不同屬性的詳細資訊，請參閱 Docker API 端點文件。

回傳值

Promise<unknown>

listImages

▸ listImages(options?): Promise<unknown>

取得本地容器映像檔清單

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

參數

名稱類型說明
options?任何（選用）。類似 JSON 的 { "all": true, "filters": JSON.stringify({ dangling: ["true"] }), "digests": true * }。如需不同屬性的詳細資訊，請參閱 Docker API 端點文件。

回傳值

Promise<unknown>