Koa Trie Router
About
Trie routing for Koa based on routington.
Routes are orthogonal and strict, so the order of definition doesn't matter.
Unlike regexp routing, there's no wildcard routing and you can't next
to the next matching route.
See routington for more details.
Versions
- Koa@1 is compatible with
1.x.x
versions of Trie-router - Koa@2 is compatible with
2.x.x
versions
Features
- Express-style routing using
router.get
,router.put
,router.post
, etc - Named URL parameters
- Responds to
OPTIONS
requests with allowed methods - Multiple route middleware
- Multiple routers
- Nestable routers
405 Method Not Allowed
support501 Not Implemented
support
Notes
The router handles /foo
and /foo/
as the different urls (see why one, two). If you need the same behavior for these urls just add koa-no-trailing-slash on the top of your middleware queue.
Usage
const Koa = const Router = let app = let router = router appapp
API
router.use(middleware...)
Handles all requests
router
router[method](middleware...)
Handles requests only by one HTTP method
router
router[method](paths, middleware...)
Handles requests only by one HTTP method and one route
Where
paths
is{String|Array<String>}
middleware
is{Function|Array<Function>|AsyncFunction|Array<AsyncFunction>}
Signature
router
router.middleware()
Like Express, all routes belong to a single middleware.
You can use koa-mount
for mounting of multiple routers:
const Koa = const mount = const Router = let app = let router1 = let router2 = router1router2 appapp
router.isImplementedMethod(method)
Checks if the server implements a particular method and returns true
or false
.
This is not middleware, so you would have to use it in your own middleware.
app
ctx.request.params
ctx.request.params
will be defined with any matched parameters.
router
Error handling
The middleware throws an error with code
MALFORMEDURL when it encounters
a malformed path. An application can try/catch this upstream, identify the error
by its code, and handle it however the developer chooses in the context of the
application- for example, re-throw as a 404.
Path Definitions
For path definitions, see routington.