Интерфейс: DockerDesktopClient

Сочетание интерфейсов версии 0 и версии 1 клиента Docker Desktop API, предоставленное для обеспечения обратной совместимости. Если вы не работаете с устаревшим расширением, используйте тип v1.

Характеристики

серверная часть

Объект window.ddClient.backend можно использовать для связи с серверной частью, определенной в разделе vm метаданных расширения. Клиент уже подключен к серверной части.

устарело :предупреждение: будет удалено в будущей версии. Вместо этого используйте DockerDesktopClient.extension.

Унаследовано от

DockerDesktopClientV0.backend


расширение

Объект ddClient.extension можно использовать для связи с серверной частью, определенной в разделе vm метаданных расширения. Клиент уже подключен к серверной части.

Унаследовано от

DockerDesktopClientV1.расширение


desktopUI

Унаследовано от

DockerDesktopClientV1.desktopUI


host

  • Readonly host:

    Host

Унаследовано от

DockerDesktopClientV1.host


docker

Унаследовано от

DockerDesktopClientV1.docker

Контейнерные методы

listContainers

listContainers(options): Promise<unknown>

Получает список запущенных контейнеров (аналогично docker ps).

По умолчанию в этом списке не отображаются остановленные контейнеры. Вы можете использовать параметр {"all": true}, чтобы выводит список всех запущенных и остановленных контейнеров.

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

устарело :предупреждение: будет удалено в будущей версии. Вместо этого используйте Docker.listContainers.

Параметры

Имя

Тип

Описание

options

never

(Необязательный). JSON, например { "all": true,   "limit": 10,   "size": true,   "filters": JSON.stringify({ status: ["exited"] }), }.Дополнительные сведения о различных свойствах см. в документация по конечной точке Docker API.

Возвращает

Promise<unknown>

Унаследовано от

DockerDesktopClientV0.listContainers


Методы образа

listImages

listImages(options): Promise<unknown>

Получает список образов

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

устарело :предупреждение: будет удалено в будущей версии. Вместо этого используйте Docker.listImages.

Параметры

Имя

Тип

Описание

options

never

(Необязательный). JSON, например {"all": true, "filters": JSON.stringify({ dangling: ["true"] }), "digests": true}. Дополнительные сведения о различных свойствах см. в документация по конечной точке Docker API.

Возвращает

Promise<unknown>

Унаследовано от

DockerDesktopClientV0.listImages



Другие методы

execHostCmd

execHostCmd(cmd): Promise ExecResultV0.

Вы можете запускать двоичные файлы, определённые в разделе хоста в метаданных расширения.

window.ddClient.execHostCmd(`cliShippedOnHost xxx`).then((cmdResult: any) => {
 console.log(cmdResult);
});

устарело :предупреждение: будет удалено в будущей версии. Вместо этого используйте ExtensionCli.exec.

Параметры

Имя

Тип

Описание

cmd

string

Команда, которую нужно выполняет.

Возвращает

Promise ExecResultV0

Унаследовано от

DockerDesktopClientV0.execHostCmd


spawnHostCmd

spawnHostCmd(cmd, args, callback): void

Вызвать двоичный файл расширения на своём хосте и получает выходной поток.

window.ddClient.spawnHostCmd(
  `cliShippedOnHost`,
  [`arg1`, `arg2`],
  (data: any, err: any) => {
    console.log(data.stdout, data.stderr);
    // Once the command exits we get the status code
    if (data.code) {
      console.log(data.code);
    }
  }
);

устарело :предупреждение: будет удалено в будущей версии. Вместо этого используйте ExtensionCli.exec.

Параметры

Имя

Тип

Описание

cmd

string

Команда, которую нужно выполняет.

args

string[]

Аргументы команды для выполнения.

callback

(data: any, error: any) => void

Функция обратного вызова, где можно прослушивать выходные данные команды и ошибки.

Возвращает

void

Унаследовано от

DockerDesktopClientV0.spawnHostCmd


execDockerCmd

execDockerCmd(cmd, …args): Promise ExecResultV0.

Вы также можете напрямую выполнить двоичный файл Docker.

const output = await window.ddClient.execDockerCmd("info");

устарело :предупреждение: будет удалено в будущей версии. Вместо этого используйте DockerCommand.exec.

Параметры

Имя

Тип

Описание

cmd

string

Команда для выполнения.

...args

string[]

Аргументы команды для выполнения.

Возвращает

Promise ExecResultV0

Результат будет содержать как стандартный вывод, так и стандартную ошибку выполненной команды:

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

Для удобства объект результата команды также имеет методы для простого анализа в зависимости от формата вывода:

  • output.lines(): string[] разделяет выходные строки.

  • output.parseJsonObject(): any анализирует правильно сформированный вывод json.

  • output.parseJsonLines(): any[] анализирует каждую строку вывода как объект json.

Если вывод команды слишком длинный или вам нужно получает вывод в виде потока, вы можете использовать функцию spawnDockerCmd:

window.ddClient.spawnDockerCmd("logs", ["-f", "..."], (data, error) => {
  console.log(data.stdout);
});

Унаследовано от

DockerDesktopClientV0.execDockerCmd


spawnDockerCmd

spawnDockerCmd(cmd, args, callback): void

устарело :предупреждение: будет удалено в будущей версии. Вместо этого используйте DockerCommand.exec.

Параметры

Имя

Тип

cmd

string

args

string[]

callback

(data: any, error: any) => void

Возвращает

void

Унаследовано от

DockerDesktopClientV0.spawnDockerCmd


openExternal

openExternal(url): void

Открывает внешний URL-адрес в системном браузере по умолчанию.

window.ddClient.openExternal("https://docker.com");

устарело :предупреждение: будет удалено в будущей версии. Вместо этого используйте Host.openExternal.

Параметры

Имя

Тип

Описание

url

string

URL-адрес, который откроет браузер (должен иметь протокол http или https).

Возвращает

void

Унаследовано от

DockerDesktopClientV0.openExternal


Методы тостов

toastSuccess

уведомление об успехе(msg): void

Отобразить всплывающее сообщение типа Success.

window.ddClient.toastSuccess("message");

устарело :предупреждение: будет удалено в будущей версии. Вместо этого используйте Toast.success.

Параметры

Имя

Тип

Описание

msg

string

Сообщение для отображения во всплывающем уведомлении.

Возвращает

void

Унаследовано от

DockerDesktopClientV0.toastSuccess


toastWarning

toastWarning(msg): void

Отображение всплывающего сообщения типа предупреждения.

window.ddClient.toastWarning("message");

устарело :предупреждение: будет удалено в будущей версии. Вместо этого используйте Toast.warning.

Параметры

Имя

Тип

Описание

msg

string

Сообщение для отображения во всплывающем уведомлении.

Возвращает

void

Унаследовано от

DockerDesktopClientV0.toastWarning


toastError

toastError(msg): void

Отображение всплывающего сообщения об ошибке типа.

window.ddClient.toastError("message");

устарело :предупреждение: будет удалено в будущей версии. Вместо этого используйте Toast.error.

Параметры

Имя

Тип

Описание

msg

string

Сообщение для отображения во всплывающем уведомлении.

Возвращает

void

Унаследовано от

DockerDesktopClientV0.toastError