@eggjs/router 2.1.0 → 2.1.1

package/README.md

@@ -32,12 +32,13 @@ Router core component for [Egg.js](https://github.com/eggjs).
 <a name="exp_module_egg-router--Router"></a>
 
 ### Router ⏏
+
 **Kind**: Exported class
 <a name="new_module_egg-router--Router_new"></a>
 
 #### new Router([opts])
-Create a new router.
 
+Create a new router.
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -62,9 +63,11 @@ app
   .use(router.routes())
   .use(router.allowedMethods());
 ```
+
 <a name="module_egg-router--Router+get|put|post|patch|delete|del"></a>
 
 #### router.get|put|post|patch|delete|del ⇒ <code>Router</code>
+
 Create `router.verb()` methods, where *verb* is one of the HTTP verbs such
 as `router.get()` or `router.post()`.
 
@@ -188,12 +191,14 @@ used to convert paths to regular expressions.
 <a name="module_egg-router--Router+routes"></a>
 
 #### router.routes ⇒ <code>function</code>
+
 Returns router middleware which dispatches a route matching the request.
 
 **Kind**: instance property of <code>[Router](#exp_module_egg-router--Router)</code>
 <a name="module_egg-router--Router+use"></a>
 
 #### router.use([path], middleware) ⇒ <code>Router</code>
+
 Use given middleware.
 
 Middleware run in the order they are defined by `.use()`. They are invoked
@@ -209,6 +214,7 @@ sequentially, requests start at the first middleware and work their way
 | [...] | <code>function</code> |
 
 **Example**
+
 ```javascript
 // session middleware will run before authorize
 router
@@ -223,9 +229,11 @@ router.use(['/users', '/admin'], userAuth());
 
 app.use(router.routes());
 ```
+
 <a name="module_egg-router--Router+prefix"></a>
 
 #### router.prefix(prefix) ⇒ <code>Router</code>
+
 Set the path prefix for a Router instance that was already initialized.
 
 **Kind**: instance method of <code>[Router](#exp_module_egg-router--Router)</code>
@@ -235,12 +243,15 @@ Set the path prefix for a Router instance that was already initialized.
 | prefix | <code>String</code> |
 
 **Example**
+
 ```javascript
 router.prefix('/things/:thing_id')
 ```
+
 <a name="module_egg-router--Router+allowedMethods"></a>
 
 #### router.allowedMethods([options]) ⇒ <code>function</code>
+
 Returns separate middleware for responding to `OPTIONS` requests with
 an `Allow` header containing the allowed methods, as well as responding
 with `405 Method Not Allowed` and `501 Not Implemented` as appropriate.
@@ -255,6 +266,7 @@ with `405 Method Not Allowed` and `501 Not Implemented` as appropriate.
 | [options.methodNotAllowed] | <code>function</code> | throw the returned value in place of the default MethodNotAllowed error |
 
 **Example**
+
 ```javascript
 var Koa = require('koa');
 var Router = require('egg-router');
@@ -283,9 +295,11 @@ app.use(router.allowedMethods({
   methodNotAllowed: () => new Boom.methodNotAllowed()
 }));
 ```
+
 <a name="module_egg-router--Router+redirect"></a>
 
 #### router.redirect(source, destination, [code]) ⇒ <code>Router</code>
+
 Redirect `source` to `destination` URL with optional 30x status `code`.
 
 Both `source` and `destination` can be route names.
@@ -314,6 +328,7 @@ router.all('/login', ctx => {
 <a name="module_egg-router--Router+route"></a>
 
 #### router.route(name) ⇒ <code>Layer</code> &#124; <code>false</code>
+
 Lookup route with given `name`.
 
 **Kind**: instance method of <code>[Router](#exp_module_egg-router--Router)</code>
@@ -325,6 +340,7 @@ Lookup route with given `name`.
 <a name="module_egg-router--Router+url"></a>
 
 #### router.url(name, params, [options]) ⇒ <code>String</code> &#124; <code>Error</code>
+
 Generate URL for route. Takes a route name and map of named `params`.
 
 **Kind**: instance method of <code>[Router](#exp_module_egg-router--Router)</code>
@@ -337,6 +353,7 @@ Generate URL for route. Takes a route name and map of named `params`.
 | [options.query] | <code>Object</code> &#124; <code>String</code> | query options |
 
 **Example**
+
 ```javascript
 router.get('user', '/users/:id', (ctx, next) => {
   // ...
@@ -359,9 +376,11 @@ router.url('user', { id: 3 }, { query: { limit: 1 } });
 router.url('user', { id: 3 }, { query: "limit=1" });
 // => "/users/3?limit=1"
 ```
+
 <a name="module_egg-router--Router+param"></a>
 
 #### router.param(param, middleware) ⇒ <code>Router</code>
+
 Run middleware for named route parameters. Useful for auto-loading or
 validation.
 
@@ -373,6 +392,7 @@ validation.
 | middleware | <code>function</code> |
 
 **Example**
+
 ```javascript
 router
   .param('user', (id, ctx, next) => {
@@ -391,9 +411,11 @@ router
   // /users/3 => {"id": 3, "name": "Alex"}
   // /users/3/friends => [{"id": 4, "name": "TJ"}]
 ```
+
 <a name="module_egg-router--Router.url"></a>
 
 #### Router.url(path, params [, options]) ⇒ <code>String</code>
+
 Generate URL from url pattern and given `params`.
 
 **Kind**: static method of <code>[Router](#exp_module_egg-router--Router)</code>
@@ -406,6 +428,7 @@ Generate URL from url pattern and given `params`.
 | [options.query] | <code>Object</code> &#124; <code>String</code> | query options |
 
 **Example**
+
 ```javascript
 var url = Router.url('/users/:id', {id: 1});
 // => "/users/1"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eggjs/router",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "engines": {
     "node": ">= 8.5.0"
   },
@@ -11,7 +11,7 @@
   "description": "Router middleware for egg/koa. Provides RESTful resource routing.",
   "repository": {
     "type": "git",
-    "url": "https://github.com/eggjs/egg-router.git"
+    "url": "git@github.com:eggjs/router.git"
   },
   "bugs": {
     "url": "https://github.com/eggjs/egg/issues"