@@ -32,7 +32,7 @@ npm install koa-router
32
32
```
33
33
34
34
## API Reference
35
-
35
+
36
36
* [ koa-router] ( #module_koa-router )
37
37
* [ Router] ( #exp_module_koa-router--Router ) ⏏
38
38
* [ new Router([ opts] )] ( #new_module_koa-router--Router_new )
@@ -44,7 +44,7 @@ npm install koa-router
44
44
* [ .allowedMethods([ options] )] ( #module_koa-router--Router+allowedMethods ) ⇒ <code >function</code >
45
45
* [ .redirect(source, destination, code)] ( #module_koa-router--Router+redirect ) ⇒ <code >Router</code >
46
46
* [ .route(name)] ( #module_koa-router--Router+route ) ⇒ <code >Layer</code > | ; <code >false</code >
47
- * [ .url(name, params)] ( #module_koa-router--Router+url ) ⇒ <code >String</code > | ; <code >Error</code >
47
+ * [ .url(name, params [ , options ] )] ( #module_koa-router--Router+url ) ⇒ <code >String</code > | ; <code >Error</code >
48
48
* [ .param(param, middleware)] ( #module_koa-router--Router+param ) ⇒ <code >Router</code >
49
49
* _ static_
50
50
* [ .url(path, params)] ( #module_koa-router--Router.url ) ⇒ <code >String</code >
@@ -224,9 +224,9 @@ sequentially, requests start at the first middleware and work their way
224
224
225
225
| Param | Type |
226
226
| --- | --- |
227
- | [ path] | <code >String</code > |
228
- | middleware | <code >function</code > |
229
- | [ ...] | <code >function</code > |
227
+ | [ path] | <code >String</code > |
228
+ | middleware | <code >function</code > |
229
+ | [ ...] | <code >function</code > |
230
230
231
231
** Example**
232
232
``` javascript
@@ -252,7 +252,7 @@ Set the path prefix for a Router instance that was already initialized.
252
252
253
253
| Param | Type |
254
254
| --- | --- |
255
- | prefix | <code >String</code > |
255
+ | prefix | <code >String</code > |
256
256
257
257
** Example**
258
258
``` javascript
@@ -340,11 +340,11 @@ Lookup route with given `name`.
340
340
341
341
| Param | Type |
342
342
| --- | --- |
343
- | name | <code >String</code > |
343
+ | name | <code >String</code > |
344
344
345
345
<a name =" module_koa-router--Router+url " ></a >
346
346
347
- #### router.url(name, params) ⇒ <code >String</code > | ; <code >Error</code >
347
+ #### router.url(name, params [ , options ] ) ⇒ <code >String</code > | ; <code >Error</code >
348
348
Generate URL for route. Takes a route name and map of named ` params ` .
349
349
350
350
** Kind** : instance method of <code >[ Router] ( #exp_module_koa-router--Router ) </code >
@@ -353,7 +353,8 @@ Generate URL for route. Takes a route name and map of named `params`.
353
353
| --- | --- | --- |
354
354
| name | <code >String</code > | route name |
355
355
| params | <code >Object</code > | url parameters |
356
-
356
+ | [ options] | <code >Object</code > | options parameter |
357
+ | [ options.query] | <code >Object</code > | ; <code >String</code > | query options |
357
358
** Example**
358
359
``` javascript
359
360
router .get (' user' , ' /users/:id' , function (ctx , next ) {
@@ -366,6 +367,12 @@ router.url('user', 3);
366
367
router .url (' user' , { id: 3 });
367
368
// => "/users/3"
368
369
370
+ router .url (' user' , { id: 3 }, { query: { limit: 1 } });
371
+ // => "/users/3?limit=1"
372
+
373
+ router .url (' user' , { id: 3 }, { query: " limit=1" });
374
+ // => "/users/3?limit=1"
375
+
369
376
router .use (function (ctx , next ) {
370
377
// redirect to named route
371
378
ctx .redirect (ctx .router .url (' sign-in' ));
@@ -381,8 +388,8 @@ validation.
381
388
382
389
| Param | Type |
383
390
| --- | --- |
384
- | param | <code >String</code > |
385
- | middleware | <code >function</code > |
391
+ | param | <code >String</code > |
392
+ | middleware | <code >function</code > |
386
393
387
394
** Example**
388
395
``` javascript
0 commit comments