Merge branch 'master' into ts

Author: atian25

History.md

@@ -1,5 +1,17 @@
 # History
 
+## 2018-05-05, Version 2.8.1 @atian25
+
+### Notable changes
+
+* **docs**
+  * fix missing d.ts
+
+### Commits
+
+  * [[`20356bffc`](http://github.com/eggjs/egg/commit/20356bffcf7e99970b44f230a6fc2a8f9547a380)] - feat(d.ts): add createAnonymousContext & runInBackground (#2501) (Hengfei Zhuang <<zhuanghengfei@gmail.com>>)
+  * [[`c013ef3e6`](http://github.com/eggjs/egg/commit/c013ef3e64e049c6ef48e29d289f6d756b6ca1f7)] - feat(d.ts): add runSchedule & Subscription define (#2504) (Hengfei Zhuang <<zhuanghengfei@gmail.com>>)
+
 ## 2018-05-03, Version 2.8.0 @dead-horse
 
 ### Notable changes
@@ -23,7 +35,7 @@
   * [[`73dac083d`](http://github.com/eggjs/egg/commit/73dac083d2a029f893e9b6737080c921027e308f)] - docs: update wxapp-socket-io project to weapp.socket.io (#2421) (liuguili <<gongzili456@gmail.com>>)
   * [[`1ada8e384`](http://github.com/eggjs/egg/commit/1ada8e3848be9f09680d7cac091fb14206df5a11)] - feat(d.ts): add middleware to Application and other ts improvement (#2465) (Axes <<whxaxes@qq.com>>)
   * [[`437785315`](http://github.com/eggjs/egg/commit/437785315f28a828ea0cf7bece80223d5b796dc5)] - docs: fix the code error of LOCALS in view.md (#2464) (zjz19901029 <<346663801@qq.com>>)
-  * [[`f341b9fb8`](http://github.com/eggjs/egg/commit/f341b9fb8bdf36b6280500578e8448c59aec10f1)] - chore: update title and remove unused files (#2433) (TZ | 
+  * [[`f341b9fb8`](http://github.com/eggjs/egg/commit/f341b9fb8bdf36b6280500578e8448c59aec10f1)] - chore: update title and remove unused files (#2433) (TZ |
 天猪 <<atian25@qq.com>>)
   * [[`a5ab29cbd`](http://github.com/eggjs/egg/commit/a5ab29cbd1de0f5425019085258a496b4bce8b45)] - docs: switch to English document (#2426) (Haoliang Gao <<sakura9515@gmail.com>>)
   * [[`4ab7df25f`](http://github.com/eggjs/egg/commit/4ab7df25f152609d494745eac2794b78e66444f0)] - deps: update dependencies, add @types/urllib to autod config (#2423) (Yiyu He <<dead_horse@qq.com>>)

README.zh-CN.md

@@ -63,9 +63,9 @@ $ open http://localhost:7001
 
 ## 贡献代码
 
-Please let us know what we can help, check [issues](https://github.com/eggjs/egg/issues) for bug reporting and suggestion.
+请告知我们可以为你做些什么，不过在此之前，请检查一下是否有[已经存在的Bug或者意见](https://github.com/eggjs/egg/issues)。
 
-If you are a contributor, follow [CONTRIBUTING](CONTRIBUTING.md).
+如果你是一个代码贡献者，请参考[代码贡献规范](CONTRIBUTING.md)。
 
 ## 开源协议
 

app/extend/context.js

@@ -13,6 +13,10 @@ const CONTEXT_HTTPCLIENT = Symbol('Context#httpclient');
 
 
 const proto = module.exports = {
+
+  /**
+   * Get the current visitor's cookies.
+   */
   get cookies() {
     if (!this[COOKIES]) {
       this[COOKIES] = new this.app.ContextCookies(this, this.app.keys);

app/extend/request.js

@@ -95,8 +95,9 @@ module.exports = {
   },
 
   /**
-   * Request remote IPv4 address
+   * Get or set the request remote IPv4 address
    * @member {String} Request#ip
+   * @param {String} ip - IPv4 address
    * @example
    * ```js
    * this.request.ip
@@ -115,10 +116,6 @@ module.exports = {
     return this._ip;
   },
 
-  /**
-   * Set the remote address
-   * @param {String} ip - IPv4 address
-   */
   set ip(ip) {
     this._ip = ip;
   },
@@ -178,7 +175,7 @@ module.exports = {
   },
 
   /**
-   * get params pass by querystring, all value are String type.
+   * get params pass by querystring, all values are of string type.
    * @member {Object} Request#query
    * @example
    * ```js

app/extend/response.js

@@ -5,10 +5,20 @@ const isJSON = require('koa-is-json');
 const REAL_STATUS = Symbol('Context#realStatus');
 
 module.exports = {
-  set length(n) {
+
+  /**
+   * Get or set the length of content.
+   *
+   * For Get: If the original content length is null or undefined, it will read out
+   * the body's content length as the return value.
+   *
+   * @member {Number} Response#type
+   * @param {Number} len The content-length to be set.
+   */
+  set length(len) {
     // copy from koa
     // change header name to lower case
-    this.set('content-length', n);
+    this.set('content-length', len);
   },
 
   get length() {
@@ -27,6 +37,17 @@ module.exports = {
     return parseInt(len, 10);
   },
 
+  /**
+   * Get or set the content-type.
+   *
+   * For Set: If type is null or undefined, this property will be removed.
+   *
+   * For Get: If the value is null or undefined, an empty string will be returned;
+   * if you have multiple values seperated by `;`, ONLY the first one will be returned.
+   *
+   * @member {String} Response#type
+   * @param {String} type The content-type to be set.
+   */
   set type(type) {
     // copy from koa
     // change header name to lower case
@@ -46,13 +67,14 @@ module.exports = {
   },
 
   /**
-   * read response real status code.
+   * Get or set a real status code.
    *
    * e.g.: Using 302 status redirect to the global error page
    * instead of show current 500 status page.
    * And access log should save 500 not 302,
    * then the `realStatus` can help us find out the real status code.
-   * @member {Number} Context#realStatus
+   * @member {Number} Response#realStatus
+   * @param {Number} status The status code to be set.
    */
   get realStatus() {
     if (this[REAL_STATUS]) {
@@ -61,12 +83,6 @@ module.exports = {
     return this.status;
   },
 
-  /**
-   * set response real status code.
-   *
-   * @member {Void} Response#realStatus
-   * @param {Number} status the real status code
-   */
   set realStatus(status) {
     this[REAL_STATUS] = status;
   },

index.d.ts

@@ -525,6 +525,8 @@ declare module 'egg' {
      */
     beforeStart(scrope: () => void): void;
 
+    runSchedule(schedulePath: string): Promise<any>;
+
     /**
      * Close all, it wil close
      * - callbacks registered by beforeClose
@@ -607,6 +609,22 @@ declare module 'egg' {
     Controller: Controller;
 
     middleware: KoaApplication.Middleware[] & IMiddleware;
+
+    /**
+     * Create an anonymous context, the context isn't request level, so the request is mocked.
+     * then you can use context level API like `ctx.service`
+     * @member {String} Application#createAnonymousContext
+     * @param {Request} req - if you want to mock request like querystring, you can pass an object to this function.
+     * @return {Context} context
+     */
+    createAnonymousContext(req?: Request): Context;
+
+    /**
+     * Run async function in the background
+     * @see Context#runInBackground
+     * @param {Function} scope - the first args is an anonymous ctx
+     */
+    runInBackground(scope: (ctx: Context) => void): void;
   }
 
   export interface FileStream extends Readable { // tslint:disable-line
@@ -861,6 +879,8 @@ declare module 'egg' {
 
   export class Service extends BaseContextClass { }
 
+  export class Subscription extends BaseContextClass { }
+
   /**
    * The empty interface `IService` is a placeholder, for egg
    * to auto injection service to ctx.service

package.json

@@ -1,6 +1,6 @@
 {
   "name": "egg",
-  "version": "2.8.0",
+  "version": "2.8.1",
   "description": "A web framework's framework for Node.js",
   "keywords": [
     "web",