egg 3.16.1 → 3.17.1

package/lib/core/messenger/ipc.js

@@ -14,7 +14,7 @@ class Messenger extends EventEmitter {
   constructor() {
     super();
     this.pid = String(process.pid);
-    // pids of agent or app maneged by master
+    // pids of agent or app managed by master
     // - retrieve app worker pids when it's an agent worker
     // - retrieve agent worker pids when it's an app worker
     this.opids = [];

package/lib/core/singleton.js

@@ -79,6 +79,11 @@ class Singleton {
     return this.clients.get(id);
   }
 
+  // alias to `get(id)`
+  getSingletonInstance(id) {
+    return this.clients.get(id);
+  }
+
   createInstance(config, clientName) {
     // async creator only support createInstanceAsync
     assert(!is.asyncFunction(this.create),

package/lib/egg.js

@@ -27,7 +27,7 @@ const EGG_PATH = Symbol.for('egg#eggPath');
 const CLUSTER_CLIENTS = Symbol.for('egg#clusterClients');
 
 /**
- * Base on koa's Application
+ * Based on koa's Application
  * @see https://github.com/eggjs/egg-core
  * @see http://koajs.com/#application
  * @augments EggCore
@@ -62,8 +62,8 @@ class EggApplication extends EggCore {
      */
     this.messenger = Messenger.create(this);
 
-    // trigger serverDidReady hook when all app workers
-    // and agent worker is ready
+    // trigger `serverDidReady` hook when all the app workers
+    // and agent worker are ready
     this.messenger.once('egg-ready', () => {
       this.lifecycle.triggerServerDidReady();
     });

package/lib/loader/app_worker_loader.js

@@ -40,7 +40,7 @@ class AppWorkerLoader extends EggLoader {
     // app
     this.loadController();
     // app
-    this.loadRouter(); // Dependent on controllers
+    this.loadRouter(); // Depend on controllers
   }
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "egg",
-  "version": "3.16.1",
+  "version": "3.17.1",
   "publishConfig": {
     "tag": "latest"
   },
@@ -46,7 +46,7 @@
     "graceful": "^1.1.0",
     "humanize-ms": "^1.2.1",
     "is-type-of": "^1.2.1",
-    "koa-bodyparser": "^4.3.0",
+    "koa-bodyparser": "^4.4.1",
     "koa-is-json": "^1.0.0",
     "koa-override": "^3.0.0",
     "ms": "^2.1.3",

package/lib/jsdoc/context.jsdoc

@@ -1,42 +0,0 @@
-/**
- * 继承 koa 的 Context
- * @class Context
- * @see http://koajs.com/#context
- */
-
-/**
- * 实现页面跳转
- * @see Response#redirect
- * @method Context#redirect
- * @param {String} url 需要跳转的地址
- */
-
-/**
- * 开启 {@link Rest} 功能后，将会有 `this.params` 对象
- * @member {Object} Context#params
- * @example
- * ##### ctx.params.id {String}
- *
- * 资源 id，如 `GET /api/users/1` => `'1'`
- *
- * ##### ctx.params.ids {Array<String>}
- *
- * 一组资源 id，如 `GET /api/users/1,2,3` => `['1', '2', '3']`
- *
- * ##### ctx.params.fields {Array<String>}
- *
- * 期待返回的资源字段，如 `GET /api/users/1?fields=name,title` => `['name', 'title']`.
- * 即使应用 Controller 实现返回了全部字段，[REST] 处理器会根据 `fields` 筛选只需要的字段。
- *
- * ##### ctx.params.data {Object}
- *
- * 请求数据对象
- *
- * ##### ctx.params.page {Number}
- *
- * 分页码，如 `GET /api/users?page=10` => `10`
- *
- * ##### ctx.params.per_page {Number}
- *
- * 每页资源数目，如 `GET /api/users?per_page=20` => `20`
- */

package/lib/jsdoc/request.jsdoc

@@ -1,48 +0,0 @@
-/**
- * 继承 koa 的 Request
- * @class Request
- * @see http://koajs.com/#request
- */
-
-
-// 文档注释
-/**
- * Request header
- * @member {Object} Request#header
- */
-
-/**
- * Request headers
- * @member {Object} Request#headers
- */
-
-/**
- * Request HTTP Method, 比如: GET, POST, PATCH, PUT, DELETE
- * @member {String} Request#method
- */
-
-/**
- * 完整的请求 URL 地址
- * @member {String} Request#url
- */
-
-/**
- * 完整的请求 URL 地址
- * @member {String} Request#originalUrl
- */
-
-/**
- * 完整的请求 URL 地址，的路径部分（不包含域名）
- * @member {String} Request#path
- */
-
-/**
- * 请求的 GET 参数
- * @member {String} Request#querystring
- * @example
- * GET http://127.0.0.1:7001?name=Foo&age=20
- * ```js
- * this.request.querystring
- * => 'name=Foo&age=20'
- * ```
- */

package/lib/jsdoc/response.jsdoc

@@ -1,5 +0,0 @@
-/**
- * 继承 koa 的 Response
- * @class Response
- * @see http://koajs.com/#response
- */