blue-server

0.1.6 • Public • Published

blue-server

通用的服务端代码抽象出来,可以快速启动一个可以马上使用的koa服务器

全局变量

提供 global.absrqr, 用于require绝对路径的代码,比如 global.absrqr("@/lib/sha1")的形式引用

提供 global.logger,可以用来log日志

配置

  • appName|string 应用名称,默认:blue-server
  • getRouter|function 路由动态require, 需要返回require('path/to/koa/router')
  • port|int 监听端口,默认3000
  • srcDirname|string src文件夹绝对路径,默认./src,用于使用global.absrqr
  • logPath|string 日志路径,默认./logs,用户使用global.logger
  • timeout|int 请求timeout时间,参考nodejs http.timeout,默认120000
  • maxHeadersCount|int 最大返回header数量限制,参考nodejs http request.maxHeadersCount
  • checkContinue|boolean 默认false, 是否自己处理checkContinue事件,参考nodejs http.Server Event:'checkContinue'
  • hostname|string, 默认空字符串,server使用的域名,为空时不设置域名
  • cors|object, 跨域配置,默认为空对象,参考@koa/cors配置。
  • startInside|boolean, 是否内部自动启动服务,默认为false,主要用于本地debug

使用方式

server文件src/server.js:

const blueServer = require('blue-server')

module.exports = blueServer({
  port: 3000,
  getRouter: () => require('./routes/route'),
  logPath: './logs',
  srcDirname: __dirname,
  appName: 'example',
  cors: {
    credentials: true,
  },
})

运行服务:blue-server src/server

Readme

Keywords

none

Package Sidebar

Install

npm i blue-server

Weekly Downloads

11

Version

0.1.6

License

MIT

Unpacked Size

17.5 kB

Total Files

15

Last publish

Collaborators

  • awayisblue