# @caraer/client 中文文档

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

版本：2\.0\.684
npm 元数据更新时间：2026-11-05T12:10:18.816Z
中文译文更新时间：2026-11-09T04:58:45.516Z
软件包许可：Unlicense

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

原始 npm 页面：https://www.npmjs.com/package/%40caraer/client
原文对照：https://npmcn.com/package/%40caraer/client/?lang=original
项目主页：https://developer.caraer.com/
源码仓库：https://github.com/Caraer-HQ/caraer-js-client

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

- 包体积（解压后）：8.2 MB，430 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2026-07-22T12:26:56.289Z
- 最新版本发布：2026-11-05T12:10:18.640Z
- 近 30 天下载量：11160（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：272（近 12 个月 272 个）

## 中文简介

为 Caraer API 创建类型脚本客户端

## 安装

```sh
npm install @caraer/client
```

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

## README

# @ caraer/ 客户

生成类型脚本客户端( xios) [卡拉尔API](https://v2.api.caraer.com/)。 。 。 .

在每次Caraer后端生产部署后,此寄存器会自动从生产OpenAPI spec中再生成. 手写无服务器有效载荷助手 `apps.ts` 被保存在整个再生过程中.

## 安装

```bash
npm install @caraer/client
```

## 文档

-   API 参考 : [https://developer.caraer.com (中文(简体) )](https://developer.caraer.com/)
-   打开API : [https://v2.api.caraer.com/api-docs.yaml 页面存档备份,存于互联网档案馆](https://v2.api.caraer.com/api-docs.yaml)
-   资料来源: [https://github.com/Caraer-HQ/Caraer-js-客户端 互联网档案馆的存檔,存档日期2013-12-22](https://github.com/Caraer-HQ/caraer-js-client)

## 认证

以 Bearer 令牌配置生成的轴客户端( 见生成) `configuration` 在第一个代码发布后帮助者).

## 无服务器应用程序有效载荷类型

为生命周期/ webhook / 调度/ 输入/ 工作机构导入打入的帮助器 (而不是运行) `caraer apps typegen`:

```ts
import type {
  LifecyclePayload,
  WebhookPayload,
  SchedulePayload,
  InboundPayload,
  JobPayload,
  SettingFieldValue,
} from "@caraer/client";

export const handler = async (req: { body: LifecyclePayload }, res: any) => {
  const body = req.body;
  // ...
};
```

普通联署材料:

```js
/**
 * @param {import('@caraer/client').LifecyclePayload} body
 */
function onInstall(body) {
  // ...
}
```

## 许可证

见 [自由主义](https://npmcn.com/package/%40caraer/client/LICENSE)。 。 。 .

## 常见问题

### @caraer/client 是什么？

为 Caraer API 创建类型脚本客户端

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

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

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

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

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

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

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

@caraer/client 使用 Unlicense 许可。作者将代码贡献到公共领域，可不受限制地使用。以上为概括，不构成法律意见，请以许可原文为准。

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

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

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

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