Router middleware for koa
- Express-style routing using
app.get,app.put,app.post, etc. - Named URL parameters.
- Named routes with URL generation.
- Responds to
OPTIONSrequests with allowed methods. - Support for
405 Method Not Allowedand501 Not Implemented. - Multiple route middleware.
- Multiple routers.
- Nestable routers.
Install using npm:
npm install koa-router- koa-router
- Router ⏏
- new Router([opts])
- instance
- .get|put|post|patch|delete ⇒
Router - .routes ⇒
function - .use([path], middleware, [...]) ⇒
Router - .prefix(prefix) ⇒
Router - .allowedMethods([options]) ⇒
function - .redirect(source, destination, code) ⇒
Router - .route(name) ⇒
Layer|false - .url(name, params) ⇒
String|Error - .param(param, middleware) ⇒
Router
- .get|put|post|patch|delete ⇒
- static
- .url(path, params) ⇒
String
- .url(path, params) ⇒
- Router ⏏
Create a new router.
| Param | Type | Description |
|---|---|---|
| [opts] | Object |
|
| [opts.prefix] | String |
prefix router paths |
Example
Basic usage:
var app = require('koa')();
var router = require('koa-router')();
router.get('/', function *(next) {...});
app
.use(router.routes())
.use(router.allowedMethods());Create router.verb() methods, where verb is one of the HTTP verbes such
as router.get() or router.post().
Match URL patterns to callback functions or controller actions using router.verb(),
where verb is one of the HTTP verbs such as router.get() or router.post().
router
.get('/', function *(next) {
this.body = 'Hello World!';
})
.post('/users', function *(next) {
// ...
})
.put('/users/:id', function *(next) {
// ...
})
.del('/users/:id', function *(next) {
// ...
});Route paths will be translated to regular expressions used to match requests.
Query strings will not be considered when matching requests.
Routes can optionally have names. This allows generation of URLs and easy renaming of URLs during development.
router.get('user', '/users/:id', function *(next) {
// ...
});
router.url('user', 3);
// => "/users/3"Multiple middleware may be given and are composed using koa-compose:
router.get(
'/users/:id',
function *(next) {
this.user = yield User.findOne(this.params.id);
yield next;
},
function *(next) {
console.log(this.user);
// => { id: 17, name: "Alex" }
}
);Nesting routers is supported:
var forums = new Router();
var posts = new Router();
posts.get('/', function *(next) {...});
posts.get('/:pid', function *(next) {...});
forums.get('/forums/:fid/posts', posts.routes());
// responds to "/forums/123/posts" and "/forums/123/posts/123"
app.use(forums.routes());Route paths can be prefixed at the router level:
var router = new Router({
prefix: '/users'
});
router.get('/', ...); // responds to "/users"
router.get('/:id', ...); // responds to "/users/:id"Named route parameters are captured and added to ctx.params.
router.get('/:category/:title', function *(next) {
console.log(this.params);
// => [ category: 'programming', title: 'how-to-node' ]
});Run middleware for named route parameters. Useful for auto-loading or validation.
router
.param('user', function *(id, next) {
this.user = users[id];
if (!this.user) return this.status = 404;
yield next;
})
.get('/users/:user', function *(next) {
this.body = this.user;
})
.get('/users/:userId/friends', function *(next) {
this.body = yield this.user.getFriends();
})
// /users/3 => {"id": 3, "name": "Alex"}
// /users/3/friends => [{"id": 4, "name": "TJ"}]Kind: instance property of Router
| Param | Type | Description |
|---|---|---|
| path | String |
|
| [middleware] | function |
route middleware(s) |
| callback | function |
route callback |
Returns router middleware which dispatches a route matching the request.
Kind: instance property of Router
Use given middleware(s) before route callback.
Only runs if any route is matched. If a path is given, the middleware will run for any routes that include that path.
Kind: instance method of Router
| Param | Type |
|---|---|
| [path] | String |
| middleware | function |
| [...] | function |
Example
router.use(session(), authorize());
// use middleware only with given path
router.use('/users', userAuth());
app.use(router.routes());Set the path prefix for a Router instance that was already initialized.
Kind: instance method of Router
| Param | Type |
|---|---|
| prefix | String |
Example
router.prefix('/things/:thing_id')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.
Kind: instance method of Router
| Param | Type | Description |
|---|---|---|
| [options] | Object |
|
| [options.throw] | Boolean |
throw error instead of setting status and header |
Example
var app = koa();
var router = router();
app.use(router.routes());
app.use(router.allowedMethods());Redirect source to destination URL with optional 30x status code.
Both source and destination can be route names.
router.redirect('/login', 'sign-in');This is equivalent to:
router.all('/login', function *() {
this.redirect('/sign-in');
this.status = 301;
});Kind: instance method of Router
| Param | Type | Description |
|---|---|---|
| source | String |
URL or route name. |
| destination | String |
URL or route name. |
| code | Number |
HTTP status code (default: 301). |
Lookup route with given name.
Kind: instance method of Router
| Param | Type |
|---|---|
| name | String |
Generate URL for route. Takes either map of named params or series of
arguments (for regular expression routes).
router.get('user', '/users/:id', function *(next) {
// ...
});
router.url('user', 3);
// => "/users/3"
router.url('user', { id: 3 });
// => "/users/3"Kind: instance method of Router
| Param | Type | Description |
|---|---|---|
| name | String |
route name |
| params | Object |
url parameters |
Run middleware for named route parameters. Useful for auto-loading or validation.
Kind: instance method of Router
| Param | Type |
|---|---|
| param | String |
| middleware | function |
Example
router
.param('user', function *(id, next) {
this.user = users[id];
if (!this.user) return this.status = 404;
yield next;
})
.get('/users/:user', function *(next) {
this.body = this.user;
})
.get('/users/:userId/friends', function *(next) {
this.body = yield this.user.getFriends();
})
// /users/3 => {"id": 3, "name": "Alex"}
// /users/3/friends => [{"id": 4, "name": "TJ"}]Generate URL from url pattern and given params.
Kind: static method of Router
| Param | Type | Description |
|---|---|---|
| path | String |
url pattern |
| params | Object |
url parameters |
Example
var url = Router.url('/users/:id', {id: 1});
// => "/users/1"Please submit all issues and pull requests to the alexmingoia/koa-router repository!
Run tests using npm test.
If you have any problem or suggestion please open an issue here.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent