Skip to content

Commit c4348d5

Browse files
committedNov 11, 2017
README: Add Router#url() query params support description and examples
1 parent b381b12 commit c4348d5

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed
 

‎README.md

+18-11
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ npm install koa-router
3232
```
3333

3434
## API Reference
35-
35+
3636
* [koa-router](#module_koa-router)
3737
* [Router](#exp_module_koa-router--Router)
3838
* [new Router([opts])](#new_module_koa-router--Router_new)
@@ -44,7 +44,7 @@ npm install koa-router
4444
* [.allowedMethods([options])](#module_koa-router--Router+allowedMethods) ⇒ <code>function</code>
4545
* [.redirect(source, destination, code)](#module_koa-router--Router+redirect) ⇒ <code>Router</code>
4646
* [.route(name)](#module_koa-router--Router+route) ⇒ <code>Layer</code> &#124; <code>false</code>
47-
* [.url(name, params)](#module_koa-router--Router+url) ⇒ <code>String</code> &#124; <code>Error</code>
47+
* [.url(name, params [, options])](#module_koa-router--Router+url) ⇒ <code>String</code> &#124; <code>Error</code>
4848
* [.param(param, middleware)](#module_koa-router--Router+param) ⇒ <code>Router</code>
4949
* _static_
5050
* [.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
224224

225225
| Param | Type |
226226
| --- | --- |
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> |
230230

231231
**Example**
232232
```javascript
@@ -252,7 +252,7 @@ Set the path prefix for a Router instance that was already initialized.
252252

253253
| Param | Type |
254254
| --- | --- |
255-
| prefix | <code>String</code> |
255+
| prefix | <code>String</code> |
256256

257257
**Example**
258258
```javascript
@@ -340,11 +340,11 @@ Lookup route with given `name`.
340340

341341
| Param | Type |
342342
| --- | --- |
343-
| name | <code>String</code> |
343+
| name | <code>String</code> |
344344

345345
<a name="module_koa-router--Router+url"></a>
346346

347-
#### router.url(name, params) ⇒ <code>String</code> &#124; <code>Error</code>
347+
#### router.url(name, params [, options]) ⇒ <code>String</code> &#124; <code>Error</code>
348348
Generate URL for route. Takes a route name and map of named `params`.
349349

350350
**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`.
353353
| --- | --- | --- |
354354
| name | <code>String</code> | route name |
355355
| params | <code>Object</code> | url parameters |
356-
356+
| [options] | <code>Object</code> | options parameter |
357+
| [options.query] | <code>Object</code> &#124; <code>String</code> | query options |
357358
**Example**
358359
```javascript
359360
router.get('user', '/users/:id', function (ctx, next) {
@@ -366,6 +367,12 @@ router.url('user', 3);
366367
router.url('user', { id: 3 });
367368
// => "/users/3"
368369

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+
369376
router.use(function (ctx, next) {
370377
// redirect to named route
371378
ctx.redirect(ctx.router.url('sign-in'));
@@ -381,8 +388,8 @@ validation.
381388

382389
| Param | Type |
383390
| --- | --- |
384-
| param | <code>String</code> |
385-
| middleware | <code>function</code> |
391+
| param | <code>String</code> |
392+
| middleware | <code>function</code> |
386393

387394
**Example**
388395
```javascript

0 commit comments

Comments
 (0)
Please sign in to comment.