Server

server~ Server

整个服务端类。这里初始化了整个项目传递各种对象的global对象。

global对象包含以下几个字段:

  1. config:项目的配置
  2. dbredis:Mongoose链接和Redis链接
  3. sio:Socket.IO对象
  4. email:Nodemailer对象
  5. users...:各种models

对于Koa的中间件来讲,这个对象可通过ctx.global获得。

Constructor

new Server()

Source:

Methods

(static) normalizeConfig(config) → {object}

将默认的项目配置与config对象合并后返回。

Source:
Parameters:
Name Type Description
config object

项目配置

Returns:
Type:
object

添加了默认配置的项目配置

(async) start(config) → {Promise.<void>}

启动服务端,初始化所有model和路由等等。

Source:
Parameters:
Name Type Description
config object

项目配置,参见example.config.json

Returns:
Type:
Promise.<void>

监听成功后resolve,否则reject

(async) stop() → {Promise.<void>}

停止服务器,停止完毕后可以再调用调用start()

Source:
Returns:
Type:
Promise.<void>

完成后resolve,否则reject