koa-modern-router
DEPRECATED
I forked koa-router originally because it was sold to an unknown actor. The Koa org now has their own official fork, so I recommend using that instead.
Simple and modern router middleware for Koa. Based on koa-router.
IMPORTANT
It is not my goal to simply maintain koa-router under a new name. There may be breaking changes in the future. If you just want to keep using koa-router safely, you should npm i koa-router@7.4.0
and always use npm ci
and
save-exact=true
in your .npmrc
.
- Express-style routing using
app.get
,app.put
,app.post
, etc. - Named URL parameters.
- Named routes with URL generation.
- Responds to
OPTIONS
requests with allowed methods. - Support for
405 Method Not Allowed
and501 Not Implemented
. - Multiple route middleware.
- Multiple routers.
- Nestable routers.
- ES7 async/await support.
Installation
Install using npm:
npm i koa-modern-router
API Reference
- koa-modern-router
- Router ⏏
- new Router([opts])
- instance
- .get|put|post|patch|delete|del ⇒
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, [options]) ⇒
String
|Error
- .param(param, middleware) ⇒
Router
- .get|put|post|patch|delete|del ⇒
- static
- .url(path, params) ⇒
String
- .url(path, params) ⇒
- inner
- Router ⏏
Router ⏏
new Router([opts])
Create a new router.
Param | Type | Description |
---|---|---|
[opts] | Object |
|
[opts.prefix] | String |
prefix router paths |
Example
Basic usage:
const Koa = const Router = const app = const router = router app
Router
router.get|put|post|patch|delete|del ⇒ Create router.verb()
methods, where verb is one of the HTTP verbs 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()
.
Additionaly, router.all()
can be used to match against all methods.
router all'/users/:id' { // ... }
When a route is matched, its path is available at ctx._matchedRoute
and if named,
the name is available at ctx._matchedRouteName
Route paths will be translated to regular expressions using path-to-regexp.
Query strings will not be considered when matching requests.
Named routes
Routes can optionally have names. This allows generation of URLs and easy renaming of URLs during development.
router router// => "/users/3"
Multiple middleware
Multiple middleware may be given:
router
Nested routers
Nesting routers is supported:
const forums = const posts = postspostsforums // responds to "/forums/123/posts" and "/forums/123/posts/123"app
Router prefixes
Route paths can be prefixed at the router level:
const router = prefix: '/users' router // responds to "/users"router // responds to "/users/:id"
URL parameters
Named route parameters are captured and added to ctx.params
.
router
The path-to-regexp module is used to convert paths to regular expressions.
Kind: instance property of Router
Param | Type | Description |
---|---|---|
path | String |
|
[middleware] | function |
route middleware(s) |
callback | function |
route callback |
function
router.routes ⇒ Returns router middleware which dispatches a route matching the request.
Kind: instance property of Router
Router
router.use([path], middleware) ⇒ Use given middleware.
Middleware run in the order they are defined by .use()
. They are invoked
sequentially, requests start at the first middleware and work their way
"down" the middleware stack.
Kind: instance method of Router
Param | Type |
---|---|
[path] | String |
middleware | function |
[...] | function |
Example
// session middleware will run before authorizerouter ; // use middleware only with given pathrouter // or with an array of pathsrouter app
Router
router.prefix(prefix) ⇒ Set the path prefix for a Router instance that was already initialized.
Kind: instance method of Router
Param | Type |
---|---|
prefix | String |
Example
routerprefix'/things/:thing_id'
function
router.allowedMethods([options]) ⇒ 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 |
[options.notImplemented] | function |
throw the returned value in place of the default NotImplemented error |
[options.methodNotAllowed] | function |
throw the returned value in place of the default MethodNotAllowed error |
Example
const Koa = const Router = const app = const router = appapp
Example with Boom
const Koa = const Router = const Boom = const app = const router = appapp
Router
router.redirect(source, destination, [code]) ⇒ Redirect source
to destination
URL with optional 30x status code
.
Both source
and destination
can be route names.
router
This is equivalent to:
routerall'/login' { ctx ctxstatus = 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). |
Layer
| false
router.route(name) ⇒ Lookup route with given name
.
Kind: instance method of Router
Param | Type |
---|---|
name | String |
String
| Error
router.url(name, params, [options]) ⇒ Generate URL for route. Takes a route name and map of named params
.
Kind: instance method of Router
Param | Type | Description |
---|---|---|
name | String |
route name |
params | Object |
url parameters |
[options] | Object |
options parameter |
[options.query] | Object | String |
query options |
Example
router router// => "/users/3" router// => "/users/3" router router// => "/users/3?limit=1" router// => "/users/3?limit=1"
Router
router.param(param, middleware) ⇒ 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 // /users/3 => {"id": 3, "name": "Zac"} // /users/3/friends => [{"id": 4, "name": "TJ"}]
String
Router.url(path, params) ⇒ 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
const url = Router// => "/users/1"
Router~sortByMostSpecificLayer(a, b)
Sort function for array of Layers. Will sort the layers with least specific first and most specific last
Kind: inner method of Router
Param | Type |
---|---|
a | Layer |
b | Layer |
Patreon Sponsors
This project is sponsored on Patreon by:
- Keeley Hammond
Contributing
Please submit all issues and pull requests to the zacanger/koa-modern-router repository. See CONTRIBUTING.md for details.