feat: add helper interface in d.ts (eggjs#1989)

Luluda · Jan 19, 2018 · dede240 · dede240
1 parent 19fe608
commit dede240
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 3 deletions.
diff --git a/app/extend/helper.js b/app/extend/helper.js
@@ -6,15 +6,15 @@ const url = require('url');
 module.exports = {
 
   /**
-   * Generate URL path(withoud host) for route. Takes the route name and a map of named params.
+   * Generate URL path(without host) for route. Takes the route name and a map of named params.
    * @method Helper#pathFor
    * @param {String} name - Router Name
    * @param {Object} params - Other params
    *
    * @example
    * ```js
    * app.get('home', '/index.htm', 'home.index');
-   * helper.pathFor('home', { by: 'recent', limit: 20 })
+   * ctx.helper.pathFor('home', { by: 'recent', limit: 20 })
    * => /index.htm?by=recent&limit=20
    * ```
    * @return {String} url path(without host)
@@ -31,7 +31,7 @@ module.exports = {
    * @example
    * ```js
    * app.get('home', '/index.htm', 'home.index');
-   * helper.urlFor('home', { by: 'recent', limit: 20 })
+   * ctx.helper.urlFor('home', { by: 'recent', limit: 20 })
    * => http://127.0.0.1:7001/index.htm?by=recent&limit=20
    * ```
    * @return {String} full url(with host)

diff --git a/index.d.ts b/index.d.ts
@@ -558,6 +558,11 @@ export interface Context extends KoaApplication.Context {
 
   response: Response;
 
+  /**
+   * helper
+   */
+  helper: IHelper;
+
   /**
    * Resource Parameters
    * @example
@@ -801,4 +806,37 @@ export interface IService { }// tslint:disable-line
 
 export interface IController { } // tslint:disable-line
 
+export interface IHelper {
+  /**
+   * Generate URL path(without host) for route. Takes the route name and a map of named params.
+   * @method Helper#pathFor
+   * @param {String} name - Router Name
+   * @param {Object} params - Other params
+   *
+   * @example
+   * ```js
+   * app.get('home', '/index.htm', 'home.index');
+   * ctx.helper.pathFor('home', { by: 'recent', limit: 20 })
+   * => /index.htm?by=recent&limit=20
+   * ```
+   * @return {String} url path(without host)
+   */
+  pathFor(name: string, params?: { [key: string]: any }): string;
+
+  /**
+   * Generate full URL(with host) for route. Takes the route name and a map of named params.
+   * @method Helper#urlFor
+   * @param {String} name - Router name
+   * @param {Object} params - Other params
+   * @example
+   * ```js
+   * app.get('home', '/index.htm', 'home.index');
+   * ctx.helper.urlFor('home', { by: 'recent', limit: 20 })
+   * => http://127.0.0.1:7001/index.htm?by=recent&limit=20
+   * ```
+   * @return {String} full url(with host)
+   */
+  urlFor(name: string, params?: { [key: string]: any }): string;
+}
+
 export as namespace Egg;