@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和锁是可选插件.
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 (英语)) (中文(简体) ). 启动后,将同一实例传递给 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 (英语)仅是添加:
- 错误基础
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 (英语)) (中文(简体) ).app.runtime财务报告和审定财务报表context.runtime给予运行时间角色( e)solo, (中文(简体) ),primary, (中文(简体) ),worker和serving。 。 。 .definePoint, (中文(简体) ),context.contribute财务报告和审定财务报表context.collect是贡献点:插件在不知道对方名称的情况下交换值,以及贡献者在收藏者之前设置的.defineProvider将提供者软件包的名称、软件包和范围保存在一个地方,其./dependency子路径.defineExtension, (中文(简体) ),checkExtension财务报告和审定财务报表createExtension延长合同(D-0064 (英语):用户子类一个插件的小基类,并只覆盖其被记录的保护钩.readExtensionEntry, (中文(简体) ),addExtensionDependencies, (中文(简体) ),isExtensionOf财务报告和审定财务报表ownDataValue(Core 0.4.2, D-0111)在每一个有扩展类的插件中同样读取一个插件的用户输入模块.DriverBackends财务报告和审定财务报表transientTranslator(核心为0.4.2, D-01111号)是插件在注册驱动程序(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 (英语)) (中文(简体) ).
不要将配置与连接对象相混淆, 永远不要日志一个拥有秘密的完整配置 。 目前的API存在自0.2.0.
npm install @dokebi/core 也带来同版本的@dokebi/配置. 通常您会用 CLI 创建一个工程( Namenpx -y @dokebi/cli init <new folder>) (中文(简体) ). npm 软件包 dokebi 不是Dokebi CLI,所以永远不要使用 npx -y dokebi。 。 。 .