# @cube-dev/platform-client 中文文档

规范地址：https://npmcn.com/package/%40cube-dev/platform-client/

版本：0\.26\.0
npm 元数据更新时间：2026-11-07T11:56:21.570Z
中文译文更新时间：2026-11-11T04:07:34.005Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cube-dev/platform-client
原文对照：https://npmcn.com/package/%40cube-dev/platform-client/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：1.1 MB，48 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：react ^18\.0\.0 \|\| ^19\.0\.0，@tanstack/react-query ^5\.0\.0
- 首次发布：2026-06-05T22:14:04.449Z
- 最新版本发布：2026-11-07T11:56:21.398Z
- 近 30 天下载量：3854（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：33（近 12 个月 33 个）

## 中文简介

立方体平台客户端

## 安装

```sh
npm install @cube-dev/platform-client
```

也可以使用：`pnpm add @cube-dev/platform-client`、`yarn add @cube-dev/platform-client`、`bun add @cube-dev/platform-client`

## README

# @cube-dev/平台-客户端

输入客户端 [方块云](https://cube.dev/) 平台控制-飞机REST API. 它将公众的OpenAPI spec包装为每个端点,请求,和响应的端到端类型,加上可选的回放查询绑定.

## 文档更改日志( C)

-   **API 参考和指南 :** [https://docs.cube.dev/api-reference/introduction (中文(简体) )](https://docs.cube.dev/api-reference/introduction)
-   **更改日志 :** [https://docs.cube.dev/api-reference/changelog 页面存档备份,存于互联网档案馆](https://docs.cube.dev/api-reference/changelog)

本套装中的每批换船日志副本也作为 [`CHANGELOG.md`](https://npmcn.com/package/%40cube-dev/platform-client/CHANGELOG.md)。 。 。 .

## 安装

```bash
npm install @cube-dev/platform-client
# or
yarn add @cube-dev/platform-client
```

## 使用量

```ts
import { createCubePlatformClient } from '@cube-dev/platform-client';

const client = createCubePlatformClient({
  baseUrl: 'https://<your-tenant>.cubecloud.dev',
  // Called on every request — return the auth headers for the Platform API.
  getHeaders: () => ({ Authorization: process.env.CUBE_API_TOKEN! }),
});

// `fetchClient` is a fully-typed openapi-fetch client: paths, params,
// request bodies and responses are all checked against the OpenAPI spec.
const { data, error } = await client.fetchClient.GET('/api/v1/deployments/', {
  params: { query: { first: 50 } },
});

for (const deployment of data?.items ?? []) {
  console.log(deployment.id, deployment.name, deployment.deploymentUrl);
}
```

### 响应查询绑定

这个 `./react-query` 切入点显示一个提供者和键入的钩子 [`@tanstack/react-query`](https://tanstack.com/query) (同行依赖,以及 `react`:

```tsx
import { createCubePlatformClient } from '@cube-dev/platform-client';
import {
  CubePlatformApiProvider,
  useCubePlatformApiQuery,
} from '@cube-dev/platform-client/react-query';

const client = createCubePlatformClient({ baseUrl, getHeaders });

function App() {
  return (
    <CubePlatformApiProvider client={client}>
      <Deployments />
    </CubePlatformApiProvider>
  );
}

function Deployments() {
  const { data } = useCubePlatformApiQuery('get', '/api/v1/deployments/');
  return <ul>{data?.items.map((deployment) => <li key={deployment.id}>{deployment.name}</li>)}</ul>;
}
```

## 类型

整套计划类型导出为 `PlatformApiSchemas`,和原始 OpenAPI 键 `paths` 编号 : `operations` 类型可供高级使用:

```ts
import type { PlatformApiSchemas, paths } from '@cube-dev/platform-client';

type Deployment = PlatformApiSchemas['Deployment'];
```

## 许可证

麻省理工学院

## 常见问题

### @cube-dev/platform-client 是什么？

立方体平台客户端

### 如何安装 @cube-dev/platform-client？

在项目目录运行 npm install @cube-dev/platform-client，或使用 pnpm add / yarn add / bun add。

### @cube-dev/platform-client 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @cube-dev/platform-client 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @cube-dev/platform-client 可以商用吗？

@cube-dev/platform-client 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cube-dev/platform-client 的下载量有多少？

根据 npm 官方下载统计，@cube-dev/platform-client 在 2026/10/11 – 2026/11/09 这 30 天内被下载 3,854 次，日均约 128 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cube-dev/platform-client 还在维护吗？

最新版本 0\.26\.0 发布于 2026/11/07（3 天前）；至今共发布 33 个版本，其中过去 12 个月发布了 33 个；首次发布于 2026/06/06。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。