@ breign/ 客户端
用于与 Brain API 交互的 TypeScript 客户端库. 这个包提供了由OpenAPI规格所生成的强型接口.
安装
npm install @breign/client
使用量
import { ... } from '@breign/client';
// Configure API key authentication
// Implementation details depend on your use case
发展
先决条件
- 节点.js(在
.nvmrc(中文(简体) )
- 无
设置
- 清除仓库
- 安装依赖性 :
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/ - 生成源文件
开始
关于 @breign/client 的常见问题
@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 和提交记录判断。