# @dokebi/core 中文文档

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

版本：0\.4\.6
npm 元数据更新时间：2026-11-05T00:05:07.220Z
中文译文更新时间：2026-11-12T15:40:34.653Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40dokebi/core
原文对照：https://npmcn.com/package/%40dokebi/core/?lang=original
源码仓库：https://git.nyx-zone.com/dokebi/framework

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

- 包体积（解压后）：830 kB，168 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.0\.0
- 运行依赖：2 个
- 首次发布：2026-10-12T11:18:25.470Z
- 最新版本发布：2026-11-05T00:05:07.092Z
- 近 30 天下载量：3176（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 14 个）

## 中文简介

最小可相容的Node.js应用和插件生命周期框架.

## 安装

```sh
npm install @dokebi/core
```

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

## README

# @dokebi/ 核心

Dokebi运行时核心,版本为0.4.0(未发布,D-0067). 自0.1.1起的变化(配置 API,插件合同 v2,即已准备好的钩子)在ChangGELOG中. 仅限无害环境管理,节点.js >=24.0.0。 默认的 CI 运行了节点 24;实际已核实的范围在寄存器记录中.

从 npm 安装核心也会安装它的正常依赖性@ dokebi/ config 。 配置从所需的插件列表中自动注册到每个app中,所以你从不自己安装或注册. Web,工人,DB,Redis,NATS和锁是可选插件.

```ts
import { Application, loadConfig } from "@dokebi/core";

const document = await loadConfig("dokebi.yaml");
const app = new Application({ config: document.options });
await app.start();
try {
  app.logger.log("info", "Application started");
} finally {
  await app.stop();
}
```

YAML 文件已经 `schemaVersion: 1` 还有一个 `options` 对象. `app.config` 是一个深度只读的快照 整个 `options` 对象,可以在构造后和停止后读取。 通过类型守护到 `loadConfig` 检查真实值并同时缩小类型。 构造 `Application` 从不搜索或读取文件; `new Application()` 以空配置运行.

工厂的 `app` 编辑 `context.app` 每个钩子都一样 `ApplicationView`。视图是每个应用程序创建一次、被冻结和只提供 `state`, (中文(简体) ), `config`, (中文(简体) ), `logger` 财务报告和审定财务报表 `runtime`它没有开始,停止,注册或得到. `context.logger` 是插件的日志器, `context.app.logger` 应用程序。 插件厂需要 `{ app, options?, entry? }` 仅(0.1.x) `dependencies` 输入已去). 创建新插件 `definePlugin`。 。 。 .

可选插件提供元数据、设置和可选的启动、准备和排出,并登记在 `app.register`。 。 。 . `ready` 在每个插件启动完成且应用程序运行后, 依依序运行 。 它是插件开始接受外部流量的地方;失败是启动失败(`PLUGIN_READY_FAILED`, (中文(简体) ), [D-0034 (英语)](https://git.nyx-zone.com/dokebi/framework/-/blob/main/docs/decisions/D-0034-ready-before-traffic.md)) (中文(简体) ). 启动后,将同一实例传递给 `app.get` 获取它的API。 注册清理 `context.defer` 在设置或启动时。 停止和取消是合作的: 已完成的应用程序无法重新启动, 运行的工作永远不会被杀死 .

`Application`, (中文(简体) ), `ConsoleLogger`, (中文(简体) ), `CoreError` 而配置加载和验证 API 从包根导出. `@dokebi/core/libraries` 有类别 `hash`, (中文(简体) ), `path`, (中文(简体) ), `collections`, (中文(简体) ), `time` 财务报告和审定财务报表 `diagnostics`。 。 。 . `sha256Stream` 财务报告和审定财务报表 `sha256File` hash 字节流和文件; `portablePathKey` 是可移植相对路径的正态比较键. `BoundedKeyedQueue` 保持 FIFO 的顺序和唯一待处理项目ID的能力 `Deadline` 让几个步骤共享一次预算。 队列不是任务执行者或取消者,而且 `Deadline` 没有计时器, 并且不会中止任何任务.

相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相相[D-0063 (英语)](https://git.nyx-zone.com/dokebi/framework/-/blob/main/docs/decisions/D-0063-core-primitives.md)仅是添加:

-   错误基础 `DokebiError` (单位:千美元)`code`, (中文(简体) ), `plugin`, (中文(简体) ), `fix`, (中文(简体) ), `hint`, (中文(简体) ), `status`, (中文(简体) ), `data`, (中文(简体) ), `details`)和形状检查 `isDokebiError`不需要继承. `CoreError` 是一个子类.
-   这个 `diagnostics` 类别 : `describeError`, (中文(简体) ), `errorCode`, (中文(简体) ), `logError`, (中文(简体) ), `logDebug` 并有一个再犯的抑制器, `Repeats`。 。 。 .
-   `defineOptions` 财务报告和审定财务报表 `option` 构建选项解析器( 无 Ajv, 路径标记) `INVALID_OPTIONS`和JSON Schema 从一个宣言, 它直接进入 `definePlugin({ options })`它支持受歧视的工会和重新命名的钥匙`option.alias`, (中文(简体) ), `option.renamed`, (中文(简体) ), [D-0071 (英语)](https://git.nyx-zone.com/dokebi/framework/-/blob/main/docs/decisions/D-0071-option-vocabulary.md)) (中文(简体) ).
-   `app.runtime` 财务报告和审定财务报表 `context.runtime` 给予运行时间角色( e)`solo`, (中文(简体) ), `primary`, (中文(简体) ), `worker`和 `serving`。 。 。 .
-   `definePoint`, (中文(简体) ), `context.contribute` 财务报告和审定财务报表 `context.collect` 是贡献点:插件在不知道对方名称的情况下交换值,以及贡献者在收藏者之前设置的.
-   `defineProvider` 将提供者软件包的名称、软件包和范围保存在一个地方,其 `./dependency` 子路径.
-   `defineExtension`, (中文(简体) ), `checkExtension` 财务报告和审定财务报表 `createExtension` 延长合同([D-0064 (英语)](https://git.nyx-zone.com/dokebi/framework/-/blob/main/docs/decisions/D-0064-extension-contract.md):用户子类一个插件的小基类,并只覆盖其被记录的保护钩.
-   `readExtensionEntry`, (中文(简体) ), `addExtensionDependencies`, (中文(简体) ), `isExtensionOf` 财务报告和审定财务报表 `ownDataValue` (Core 0.4.2, D-0111)在每一个有扩展类的插件中同样读取一个插件的用户输入模块.
-   `DriverBackends` 财务报告和审定财务报表 `transientTranslator` (核心为0.4.2, [D-01111号](https://git.nyx-zone.com/dokebi/framework/-/blob/main/docs/decisions/D-0111-driver-backends.md))是插件在注册驱动程序(dokebi-cache, dokebi-lock)上带有命名后端的共享机械:驱动程序注册,入门模块和扩展钩,可选驱动包加载,设置,清理和提供者,以及其瞬态错误的可重试的503翻译.
-   测试入口 `@dokebi/core/testing` 提供 `createTestApplication` (自动停止,用假名取代提供者,这是网络插件的插槽) `inject`和 `captureLogger`。 。 。 .

加密不是核心的一部分 。 可选软件包 `@dokebi/seal` (D-0059,原为 `@dokebi/crypto`)拥有它和浏览器WebSocket客户端.

日志级别来自环境变量 `DOKEBI_LOG_LEVEL` (调试,信息,警告,错误,沉默),然后是多克比. 雅姆尔 `options.logging.level`,然后输入信息. `options.logging.plugins` 每个插件设置关卡。 当代码通过日志时,日志会决定应用级别. 在调试时,每个插件的生命周期步骤都会随起始、结束和已过期时间而记录([D-0047 (英语)](https://git.nyx-zone.com/dokebi/framework/-/blob/main/docs/decisions/D-0047-logging-and-no-silent-errors.md)) (中文(简体) ).

不要将配置与连接对象相混淆, 永远不要日志一个拥有秘密的完整配置 。 目前的API存在自0.2.0.

`npm install @dokebi/core` 也带来同版本的@dokebi/配置. 通常您会用 CLI 创建一个工程( Name`npx -y @dokebi/cli init <new folder>`) (中文(简体) ). npm 软件包 `dokebi` 不是Dokebi CLI,所以永远不要使用 `npx -y dokebi`。 。 。 .

Core持有麻省理工学院的执照. 见捆绑 [大赦国际指南](https://npmcn.com/package/%40dokebi/core/AI.md),公共类型声明和 [仓库](https://git.nyx-zone.com/dokebi/framework)。 。 。 .

## 常见问题

### @dokebi/core 是什么？

最小可相容的Node\.js应用和插件生命周期框架\.

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

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

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

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

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

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

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

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

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

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

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

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

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

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