# @breign/client 中文文档

规范地址：https://npmcn.com/package/%40breign/client/

版本：1\.0\.203
npm 元数据更新时间：2026-11-04T15:32:14.120Z
中文译文更新时间：2026-11-08T14:37:05.838Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：6.2 MB，1669 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2025-06-04T15:04:44.461Z
- 最新版本发布：2026-11-04T15:32:13.929Z
- 近 30 天下载量：5845（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：204（近 12 个月 176 个）

## 中文简介

用于与 Brain API 交互的 TypeScript 客户端库. 这个包提供了由OpenAPI规格所生成的强型接口.

## 安装

```sh
npm install @breign/client
```

也可以使用：`pnpm add @breign/client`、`yarn add @breign/client`、`bun add @breign/client`

## README

# @ breign/ 客户端

用于与 Brain API 交互的 TypeScript 客户端库. 这个包提供了由OpenAPI规格所生成的强型接口.

## 安装

```bash
npm install @breign/client
```

## 使用量

```typescript
import { ... } from '@breign/client';

// Configure API key authentication
// Implementation details depend on your use case
```

## 发展

### 先决条件

-   节点.js(在 `.nvmrc`(中文(简体) )
-   无

### 设置

1.  清除仓库
2.  安装依赖性 :
    
    ```bash
    npm install
    ```
    

### 可用的脚本

-   `npm run generate` - 从 OpenAPI 规格生成 API 客户端
-   `npm run build` - 构建 TypeScript 项目
-   `npm run clean` - 生成和建立目录
-   `npm run format` - 使用Pretier格式代码
-   `npm run format:check` - 检查代码格式

### 项目结构

-   `src/resources/openapi/` - OpenAPI规格
-   `dist/` - 编译产出
-   `target/` - 生成源文件

## 开始

-   [ ] 生成移动开发的API( Swift, Kotlin) ?
-   [ ] 决定我们是否应该使用日期或字符串的格式?

## 常见问题

### @breign/client 是什么？

用于与 Brain API 交互的 TypeScript 客户端库\. 这个包提供了由OpenAPI规格所生成的强型接口\.

### 如何安装 @breign/client？

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

### @breign/client 支持 TypeScript 吗？

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

### @breign/client 支持 ESM 还是 CommonJS？

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

### @breign/client 可以商用吗？

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

### @breign/client 的下载量有多少？

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

### @breign/client 还在维护吗？

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