跳到主要内容

core - 核心

核心模块用于模块的加载与服务启动

依赖模块

配置项

配置项类型默认值功能
envstringdevelopment执行环境,开发环境为 development 生产环境为 production,一般通过 NODE_ENV 环境变量指定
keysstring[]Cookie 签名密钥
proxybooleanfalse信任代理头信息,例如前级为 Nginx 为了取得真实客户端 ip 地址需要设置为 true
subdomainOffsetnumber子域名位置
proxyIpHeaderstringX-Forwarded-For代理后客户端真实 ip 头字段名
maxIpsCountnumber0多级代理后允许的 ip 数量,0 无限制

Core 挂载项

挂载项类型功能
namestring应用名称,获取顺序: env.APP_NAME、hostname
startTimenumber启动时间: 毫秒时间戳
appKoa取得 Koa 实例
loadedModulesLoadedModule[]已载入的模块
serverServer取得 http.Server 实例
debugDebuggercore debug 方法

Context 挂载项

挂载项类型功能
coreCoreCore 模块实例

全局方法

名称功能
initCore初始化全局 Core 对象
getCore取得全局 Core 对象
getContext取得当前请求上下文对象

自定义模块入口样例代码

import { SetupFunction } from '@zenweb/core';

// 自定义模块配置项
export interface MyModOption {}

// 是否有 opt 参数或者其他参数由模块开发者自定义
export default function (opt?: MyModOption): SetupFunction {
// 返回函数的名称将作为模块名称显示
return function mymodname(setup) {}
}