koa-router - npm Package Compare versions

Comparing version 4.1.0 to 4.2.0

lib/router.js

@@ -50,2 +50,3 @@ /**
  * @alias module:koa-router
+ * @constructor
  */
@@ -580,2 +581,18 @@
 /**
+ * Generate URL from url pattern and given `params`.
+ *
+ * @example
+ *
+ *   var url = Router.url('/users/:id', {id: 1});
+ *   // => "/users/1"
+ *
+ * @param {String} path url pattern
+ * @param {Object} params url parameters
+ * @returns {String}
+ */
+Router.url = function (path, params) {
+    return Route.prototype.url.call({path: path}, params);
+};
+
+/**
  * Merge b into a.
@@ -582,0 +599,0 @@ *

package.json

@@ -13,3 +13,3 @@ {
   "author": "Alex Mingoia <[e-mail]>",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "keywords": [
@@ -16,0 +16,0 @@ "koa",

README.md

@@ -27,15 +27,21 @@ # koa-router
 * [koa-router](#module_koa-router)
-  * [Router()](#exp_module_koa-router--Router) ⏏
-    * [.get|put|post|patch|delete](#module_koa-router--Router#get|put|post|patch|delete) ⇒ <code>Router</code>
-    * [.routes](#module_koa-router--Router#routes) ⇒ <code>function</code>
-    * [.use(middleware, [...])](#module_koa-router--Router#use) ⇒ <code>Router</code>
-    * [.allowedMethods([options])](#module_koa-router--Router#allowedMethods) ⇒ <code>function</code>
-    * [.all(name, path, [middleware], callback)](#module_koa-router--Router#all) ⇒ <code>Router</code>
-    * [.redirect(source, destination, code)](#module_koa-router--Router#redirect) ⇒ <code>Router</code>
-    * [.route(name)](#module_koa-router--Router#route) ⇒ <code>Route</code> \| <code>false</code>
-    * [.url(name, params)](#module_koa-router--Router#url) ⇒ <code>String</code> \| <code>Error</code>
-    * [.param(param, middleware)](#module_koa-router--Router#param) ⇒ <code>Router</code>
+  * [class: Router](#exp_module_koa-router--Router) ⏏
+    * [new Router()](#new_module_koa-router--Router_new)
+    * _instance_
+      * [.get|put|post|patch|delete](#module_koa-router--Router#get|put|post|patch|delete) ⇒ <code>Router</code>
+      * [.routes](#module_koa-router--Router#routes) ⇒ <code>function</code>
+      * [.use(middleware, [...])](#module_koa-router--Router#use) ⇒ <code>Router</code>
+      * [.allowedMethods([options])](#module_koa-router--Router#allowedMethods) ⇒ <code>function</code>
+      * [.all(name, path, [middleware], callback)](#module_koa-router--Router#all) ⇒ <code>Router</code>
+      * [.redirect(source, destination, code)](#module_koa-router--Router#redirect) ⇒ <code>Router</code>
+      * [.route(name)](#module_koa-router--Router#route) ⇒ <code>Route</code> \| <code>false</code>
+      * [.url(name, params)](#module_koa-router--Router#url) ⇒ <code>String</code> \| <code>Error</code>
+      * [.param(param, middleware)](#module_koa-router--Router#param) ⇒ <code>Router</code>
+    * _static_
+      * [.url(path, params)](#module_koa-router--Router.url) ⇒ <code>String</code>
 
 <a name="exp_module_koa-router--Router"></a>
-### Router() ⏏
+### class: Router ⏏
+<a name="new_module_koa-router--Router_new"></a>
+#### new Router()
 Create a new router.
@@ -318,2 +324,16 @@
 ```
+<a name="module_koa-router--Router.url"></a>
+#### Router.url(path, params) ⇒ <code>String</code>
+Generate URL from url pattern and given `params`.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| path | <code>String</code> | url pattern |
+| params | <code>Object</code> | url parameters |
+
+**Example**  
+var url = Router.url('/users/:id', {id: 1});
+  // => "/users/1"
+
 ## Contributing
@@ -320,0 +340,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

32425

increased by3.23%

Lines of code

725

increased by2.26%

Number of lines in readme file

348

increased by6.1%

No dependency changes