# @antelopejs/core 中文文档

规范地址：https://npmcn.com/package/%40antelopejs/core/

版本：1\.20\.0
npm 元数据更新时间：2026-11-04T19:29:02.435Z
中文译文更新时间：2026-11-06T06:25:40.458Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40antelopejs/core
原文对照：https://npmcn.com/package/%40antelopejs/core/?lang=original
项目主页：https://framework.antelopejs.com/
源码仓库：https://github.com/AntelopeJS/antelopejs

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

- 包体积（解压后）：1.7 MB，680 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：^20\.19\.0 \|\| \>=22\.12\.0
- 运行依赖：12 个
- 首次发布：2025-05-08T22:36:31.898Z
- 最新版本发布：2026-11-04T19:29:02.086Z
- 近 30 天下载量：17606（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：74（近 12 个月 69 个）

## 中文简介

TypeScript框架通过明确的合同和可替换模块,将六边形架构扩展到您的应用及其生态系统.

## 安装

```sh
npm install @antelopejs/core
```

也可以使用：`pnpm add @antelopejs/core`、`yarn add @antelopejs/core`、`bun add @antelopejs/core`

## README

![AntelopeJS logo](https://npmcn.com/package/%40antelopejs/core/.github/assets/logo.png)

# 羚羊JS

**六边形建筑,超出你自己的代码.**

[![npm](https://img.shields.io/npm/v/@antelopejs/core?style=for-the-badge&labelColor=000000&color=000000)](https://www.npmjs.com/package/@antelopejs/core) [![License](https://img.shields.io/npm/l/@antelopejs/core?style=for-the-badge&labelColor=000000&color=000000)](https://npmcn.com/package/%40antelopejs/core/LICENSE) [![Discord](https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000)](https://discord.gg/g4pFt6eXqu) [![Docs](https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000)](https://framework.antelopejs.com/docs/get-started/introduction)

[文档](https://framework.antelopejs.com/docs/get-started/introduction) • 妇女 [快开始](https://npmcn.com/package/%40antelopejs/core/#readme-quick-start) • 妇女 [解析器](https://discord.gg/g4pFt6eXqu)

如果羚羊JS拯救了您的工作,一个QQ帮助其他开发者找到它.

![Screen recording from the AntelopeJS framework film. A hexagon labelled your code is surrounded by auth, mail, queue, database, payment and storage modules under the caption Hexagonal architecture, beyond your own code. In antelope.config.ts the nodemailer provider is replaced by brevo under the caption Change providers in one file. git diff --stat then reports 1 file changed, and a grid of the project's source files stays marked unchanged under the caption Your code stays the same.](https://npmcn.com/package/%40antelopejs/core/.github/assets/swap.gif)

**羚羊JS框架 (3:41).** 合同,供应商 你可以互换,你自己的模块和一个CLI.

[https://github.com/user-attachments/assets/c632616c-e48d-4c7e-9306-22ad0f4a6351 (中文(简体) )](https://github.com/user-attachments/assets/c632616c-e48d-4c7e-9306-22ad0f4a6351)

羚羊JS是一个用于Node.js应用的TypeScript框架和CLI. 它将端口和适应器模型从您自己的代码扩展至您安装的模块:业务模块取决于合同,供应商模块执行,以及选择供应商运行的应用程序. 开源后台 [羚羊JS 隐形物](https://github.com/AntelopeJS/dms) 以它为基础.

## 为什么羚羊JS

![A business module depends on the database contract; the MongoDB and RethinkDB modules implement it; antelope.config.ts selects MongoDB.](https://npmcn.com/package/%40antelopejs/core/.github/assets/contract-model.svg)

-   **合同,不是进口.** 模块导入接口包, 如 [`@antelopejs/interface-database`](https://github.com/AntelopeJS/interface-database)中,从没有其他模块的文件.
-   **供应商你可以交换.** [`@antelopejs/postgres`](https://github.com/AntelopeJS/postgres), (中文(简体) ), [`@antelopejs/mongodb`](https://github.com/AntelopeJS/mongodb),以及 [`@antelopejs/rethinkdb`](https://github.com/AntelopeJS/rethinkdb) 执行同样的数据库合同. `antelope.config.ts` 从 npm、 Git 或本地文件夹中选择一个.
-   **一次运行时间 窃听他们.** 核心将每个接口绑定到提供者,排队呼叫直到提供者准备好,并运行每个模块的 `construct`, (中文(简体) ), `start`, (中文(简体) ), `stop`,以及 `destroy` 步骤.
-   **开发中热重载.** `ajs project dev --watch` 在不重新启动其它模块的情况下重新装入已更改的模块.
-   **一个CLI.** `ajs` 创建项目和模块,添加提供者,运行测试,构建并启动应用程序. 主机应用程序也可以通过运行时间嵌入 `createRuntime`。 。 。 .

替换提供商只有在支持合同版本和代码依赖的行为时才保留消费代码不变. 您仍然处理它的配置、 证书和数据迁移 .

## 安装

节点.js版本的羚羊JS支持是: `engines` 报告 [`package.json`](https://npmcn.com/package/%40antelopejs/core/package.json)运行 `npm view @antelopejs/core engines` 读取它们 出版发行。 首先没有要安装的东西:下面的快速启动运行 CLI 以 `npx`获得 `ajs` 命令上 `PATH`,在全球安装CLI:

```bash
pnpm add -g @antelopejs/core
```

## 快开始

创建首个模块的项目,然后以开发模式运行. 在一个列出的项目内 `@antelopejs/core` 作为依赖, npx 运行已安装的复制 :

```bash
npx @antelopejs/core project init my-app --template blank-typescript --pm pnpm --no-git-init
cd my-app
npx @antelopejs/core project dev --watch
```

保留旗子以交互选择模板 。 例如,模板由 swit 命名 `blank-typescript` 财务报告和审定财务报表 `dms-demo`。 。 。 .

为您模块使用的接口添加一个提供者 . `ajs project modules install` 对于还没有模块执行的每个接口,都添加一个:

```bash
npx @antelopejs/core project modules add @antelopejs/mongodb
npx @antelopejs/core project modules install
```

## 插件

正式插件将命令组添加到 `ajs` 和作为单独全球软件包的船舶:

| 命令 | 软件包 | 目的 |
| --- | --- | --- |
| `ajs dms` | [`@antelopejs/dms-frontend`](https://github.com/AntelopeJS/dms-frontend) | 开发、构建和部署 DMS 前端 |

当插件缺失时, `ajs` 提供安装CLI的软件包管理器. `ajs plugins` 列出正式插件. `ajs update` 更新全球安装的 CLI 和每个正式插件.

## 代理技能

`@antelopejs/core` 框架的代理技能 `skills/`,在 `antelopeJs.skills`数字 : `antelopejs` (心理模型和路由器), `ajs-cli`, (中文(简体) ), `ajs-consume-interface`,以及 `ajs-author-interface`。每个项目都获得它安装的核心版本的技能。 这个 [羚羊JS代理技能](https://github.com/AntelopeJS/agent-skills) 同步将它们链接到项目中 `.claude/skills/` 财务报告和审定财务报表 `.agents/skills/`就像它为每门技能 包船。 移民局助理`@antelopejs/dms-ai`)自己装入.

## 文档

-   [导言](https://framework.antelopejs.com/docs/get-started/introduction):为什么同样的界限在你的应用及其依赖关系上都很重要
-   [快开始](https://framework.antelopejs.com/docs/get-started/quick-start): 创建和运行您的第一个工程
-   [建筑](https://framework.antelopejs.com/docs/get-started/architecture)合同、执行和应用程序组装
-   [接口](https://framework.antelopejs.com/docs/concepts/interfaces) 财务报告和审定财务报表 [模块](https://framework.antelopejs.com/docs/concepts/modules):确定和执行一种能力
-   [配置](https://framework.antelopejs.com/docs/concepts/configuration): 选择模块源并配置提供者
-   [CLI 欺骗表](https://framework.antelopejs.com/docs/cli/cheat-sheet): 每一个 `ajs` 命令
-   [界面目录](https://interfaces.antelopejs.com/):正式合同及其执行情况

## 兼容性

| 软件包 | 支助 | 测试过 |
| --- | --- | --- |
| `@antelopejs/interface-core` | `>=0.4.0 <0.5.0` | `0.4.0` |

这个 `engines` 领域 [`package.json`](https://npmcn.com/package/%40antelopejs/core/package.json) 持有支持的Node.js范围 。 合同 `@antelopejs/core` 执行是 [`@antelopejs/interface-core`](https://github.com/AntelopeJS/interface-core),其范围上表列出.

## 捐款

读取 [捐款额](https://npmcn.com/package/%40antelopejs/core/CONTRIBUTING.md) 在你打开拉动请求之前。 当地检查为:

```bash
pnpm install
pnpm lint
pnpm test
```

## 许可证

[阿帕奇 - 2.0](https://npmcn.com/package/%40antelopejs/core/LICENSE)

## 所需资源

这个软件包需要节点.js `^20.19.0 || >=22.12.0`。 。 。 .

## 常见问题

### @antelopejs/core 是什么？

TypeScript框架通过明确的合同和可替换模块,将六边形架构扩展到您的应用及其生态系统\.

### 如何安装 @antelopejs/core？

在项目目录运行 npm install @antelopejs/core，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 ajs，可以用 npx ajs 直接运行。

### @antelopejs/core 支持 TypeScript 吗？

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

### @antelopejs/core 支持 ESM 还是 CommonJS？

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

### @antelopejs/core 需要什么版本的 Node\.js？

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

### @antelopejs/core 可以商用吗？

@antelopejs/core 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @antelopejs/core 的下载量有多少？

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

### @antelopejs/core 还在维护吗？

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