# @automate\.ax/api-contract 中文文档

规范地址：https://npmcn.com/package/%40automate.ax/api-contract/

版本：0\.165\.0
npm 元数据更新时间：2026-10-28T17:59:53.081Z
中文译文更新时间：2026-11-07T06:48:56.668Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40automate.ax/api-contract
原文对照：https://npmcn.com/package/%40automate.ax/api-contract/?lang=original
项目主页：https://docs.automate.ax/

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

- 包体积（解压后）：1.4 MB，165 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：7 个
- 首次发布：2026-07-29T20:52:08.140Z
- 最新版本发布：2026-10-28T17:59:52.855Z
- 近 30 天下载量：2339（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：300（近 12 个月 300 个）

## 中文简介

Automate.ax API的公共ORPC合同.

## 安装

```sh
npm install @automate.ax/api-contract
```

也可以使用：`pnpm add @automate.ax/api-contract`、`yarn add @automate.ax/api-contract`、`bun add @automate.ax/api-contract`

## README

# `@automate.ax/api-contract`

Automate.ax API的共享ORPC程序合同. 使用的公共合同 `@automate.ax/client` 不包括第一党和运行时间程序.

大多数应用程序应安装 `@automate.ax/client` 换句话说.

## 常见问题

### @automate\.ax/api-contract 是什么？

Automate\.ax API的公共ORPC合同\.

### 如何安装 @automate\.ax/api-contract？

在项目目录运行 npm install @automate\.ax/api-contract，或使用 pnpm add / yarn add / bun add。

### @automate\.ax/api-contract 支持 TypeScript 吗？

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

### @automate\.ax/api-contract 支持 ESM 还是 CommonJS？

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

### @automate\.ax/api-contract 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @automate\.ax/api-contract 可以商用吗？

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

### @automate\.ax/api-contract 的下载量有多少？

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

### @automate\.ax/api-contract 还在维护吗？

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