tick-core-http-server——http server的手脚架
说明
这是一个http server的手脚架,基于node自身的cluster,集成了routing-controllers和一个日志组件tick-core-logger。
快速开始
npm install @tick-core/http-server --save
npm install routing-controllers --save
npm install @tick-core/logger --save
import { createBaseServer } from '@tick-core/http-server'
createBaseServer(
{
pm2?: boolean,
port?: number,
isLocal?: boolean,
publicPath?: string
controllerPath?: string | string[],
controllerPattern?: string | string[],
middlewareRegsiter?: (app: Koa) => void,
workers?: number,
logPath: string,
cutTime?: CutTime,
backPath?: string,
rule?: 'YYYY-MM-DD' | 'YYYY-MM' | 'YYYY',
before?: (ctx: Context) => Promise<any>,
after?: (ctx: Context) => Promise<any>,
workerBefores?: string[],
underscore?: boolean,
}
)
参数 | 描述 |
---|---|
pm2 |
是否是pm2模式 |
port |
端口号 |
isLocal |
是否为本地开发 |
publicPath |
静态资源路径 |
controllerPath |
controller path |
controllerPattern |
controller 文件后缀 |
middlewareRegsiter |
自定义的中间件 |
workers |
需要启动的进程数 |
logPath |
实时日志地址 |
cutTime |
日志切割时间 |
backPath |
日志切割后存储的位置【非pm2模式下必须】 |
rule |
日志切割后存储路径规则,即文件命名规则 |
before |
前置的中间件 |
after |
后置的中间件 |
workerBefores |
每个进程启动前需要加载的文件 |
underscore |
返回参数是下划线方式,默认驼峰 |
- 路由操作参见:routing-controllers
- 日志使用参见:tick-core-logger