扩展 UI API
扩展 UI 在沙盒环境中运行,无权访问任何 electron 或 nodejs API。
扩展 UI API 为前端提供了一种执行不同操作的方法 以及与 Docker Desktop 仪表板或底层系统通信。
具有 Typescript 支持的 JavaScript API 库可用于将所有 API 定义放入扩展代码中。
- @docker/extension-api-client 提供对扩展 API entrypoint 的访问权限。
DockerDesktopCLient
- @docker/extension-api-client-types 可以添加为开发依赖项,以便在 IDE 中自动完成类型。
import { createDockerDesktopClient } from '@docker/extension-api-client';
export function App() {
// obtain Docker Desktop client
const ddClient = createDockerDesktopClient();
// use ddClient to perform extension actions
}
该对象提供对各种 API 的访问:ddClient
在此处查找扩展 API 参考。