# @bimdata/typescript-fetch-api-client 中文文档

规范地址：https://npmcn.com/package/%40bimdata/typescript-fetch-api-client/

版本：10\.49\.0
npm 元数据更新时间：2026-11-06T16:34:26.847Z
中文译文更新时间：2026-11-08T02:43:13.843Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40bimdata/typescript-fetch-api-client
原文对照：https://npmcn.com/package/%40bimdata/typescript-fetch-api-client/?lang=original
项目主页：https://github.com/bimdata/typescript-fetch-api-client-generator/tree/master/package
源码仓库：https://github.com/bimdata/typescript-fetch-api-client-generator

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

- 包体积（解压后）：2.9 MB，618 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2021-01-18T09:44:54.781Z
- 最新版本发布：2026-11-06T16:34:26.507Z
- 近 30 天下载量：2414（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：233（近 12 个月 30 个）

## 中文简介

@bimdata/typescript-fetch-api-客户端的 OpenAPI 客户端

## 安装

```sh
npm install @bimdata/typescript-fetch-api-client
```

也可以使用：`pnpm add @bimdata/typescript-fetch-api-client`、`yarn add @bimdata/typescript-fetch-api-client`、`bun add @bimdata/typescript-fetch-api-client`

## README

# @ bimdata/ typescript- fetch- api- 客户端

此软件包提供了一个javascript客户端可以与 [BIMData API 数据](https://api.bimdata.io/doc#/) 以及 用于打字和自动完成VSCode的所有必要打字.

此软件包是使用 [OpenAPI 生成器](https://openapi-generator.tech/)。 。 。 .

## 安装

要安装此软件包只需运行 : `npm install @bimdata/typescript-fetch-api-client`

## 使用量

**说明:** 本节是关于在您的工程中使用打字符- fetch API 客户端, 如果您想知道更多有关 BIMData API 及其可能的操作,请参见 [文件](https://developers.bimdata.io/)。 。 。 .

### 初始化并使用 API 客户端

为了执行给API的调用,您需要创建一个配置对象的API客户端. 下面的片段显示了一个如何做到的例子.

这个 `credentials` 参数是可选的,并在获取方法中添加此选项. 如果未设定, 将使用默认的获取选项 .

```javascript
import { makeBIMDataApiClient } from '@bimdata/typescript-fetch-api-client';

const apiClient = makeBIMDataApiClient({ apiUrl, accessToken, credentials });

apiClient.collaborationApi.getClouds().then(
  clouds => console.log('Here is the list of clouds: ', clouds)
);
```

一旦客户端创建, 您可以以这种方式更新其访问符 :

```javascript
apiClient.accessToken = newAccessToken
```

## 常见问题

### @bimdata/typescript-fetch-api-client 是什么？

@bimdata/typescript-fetch-api-客户端的 OpenAPI 客户端

### 如何安装 @bimdata/typescript-fetch-api-client？

在项目目录运行 npm install @bimdata/typescript-fetch-api-client，或使用 pnpm add / yarn add / bun add。

### @bimdata/typescript-fetch-api-client 支持 TypeScript 吗？

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

### @bimdata/typescript-fetch-api-client 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @bimdata/typescript-fetch-api-client 可以商用吗？

@bimdata/typescript-fetch-api-client 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @bimdata/typescript-fetch-api-client 的下载量有多少？

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

### @bimdata/typescript-fetch-api-client 还在维护吗？

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