Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ctdio/koa-path-router
Fast router for Koa
https://github.com/ctdio/koa-path-router
koa router
Last synced: 4 months ago
JSON representation
Fast router for Koa
- Host: GitHub
- URL: https://github.com/ctdio/koa-path-router
- Owner: ctdio
- Created: 2017-05-01T01:26:45.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-10-17T02:07:07.000Z (over 7 years ago)
- Last Synced: 2024-10-01T02:21:37.447Z (4 months ago)
- Topics: koa, router
- Language: JavaScript
- Homepage:
- Size: 120 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# koa-path-router
[](https://travis-ci.org/charlieduong94/koa-path-router)
[](https://coveralls.io/github/charlieduong94/koa-path-router?branch=master)
Fast and simple routing for [koa](https://github.com/koajs/koa).
[radix-router](https://github.com/charlieduong94/radix-router) is used to achieve fast and
consistent lookups.
## Installation
```bash
npm i --save koa-path-router
```
## Usage
### A minimal example
```js
const Koa = require('koa')
const app = new Koa()
const Router = require('koa-path-router')
const router = new Router({
// define middleware for all routes (optional)
middleware: [
async (ctx, next) => {
const startTime = Date.now()
await next()
console.log(`Request took ${Date.now() - startTime} ms`)
}
]
})
// add routes via the register function
router.register({
path: '/hello',
method: 'GET',
handler: async (ctx) => {
ctx.body = 'Hello world'
}
})
app.use(router.getRequestHandler())
app.listen(8080, () => {
console.log('Server is listening on port 8080')
})
```
### Creating an instance of the router
```js
const Router = require('koa-path-router')
const router = new Router()
```
Middleware for all routes handled by the router can be passed into the constructor
```js
const router = new Router({
// define middleware for all routes (optional)
middleware: [
async (ctx, next) => {
const startTime = Date.now()
await next()
console.log(`Request took ${Date.now() - startTime} ms`)
}
]
})
```
### Adding more middleware
Additional middleware can be added to _subsequent_ routes via `use`:
```js
router.use(async (ctx, next) => {
console.log('another layer of middleware')
return next()
})
```
Multiple functions can be passed in if needed:
```js
router.use(...middlewareFuncs)
// or
router.use(functionA, functionB)
```
### Registering routes
Routes can be added by using the `register` function:
```js
// add routes via the register function
router.register({
path: '/some/path',
method: 'POST',
// route specific middleware (optional)
middleware: [
async (ctx, next) => {
const startTime = Date.now()
await next()
console.log(Date.now() - startTime)
}
]
handler: async (ctx) => {
ctx.body = 'Hello world'
}
})
```
You can grab querystring values from the `ctx.request` object (as usual).
```js
router.register({
path: '/some/route',
method: 'GET',
handler: async (ctx) => {
const { query } = ctx.request
// a request to '/some/route?key=value'
// will set query to { key: 'value' }
ctx.body = `Hello world`
}
})
```
Placeholders are added by specifying a segment with a colon (`:`).
These values are placed on the `ctx.request` object:
```js
router.register({
path: '/some/:placeholder',
method: 'GET',
handler: async (ctx) => {
const { placeholder } = ctx.request.params
ctx.body = `Hello ${placeholder}`
}
})
```
Wildcard routes can be added by appending a `/**` to the end of a route:
```js
router.register({
path: '/wild/**',
method: 'GET',
handler: async (ctx) => {
// any requests to urls such as '/wild/card' or '/wild/path/not/defined/'
// will be routed here
ctx.body = 'wild!'
}
})
```
Express style functions are exposed for convenience:
```js
router.get('/another/path', async (ctx) => {
ctx.body = 'Hello world'
})
router.post('/some/other/path', async (ctx) => {
ctx.body = 'Hello world again'
})
```
Multiple middleware functions can be passed in before the final handler as well:
```js
router.post('/a/path',
// middleware A
async (ctx, next) => {
next()
},
// middleware B
async (ctx, next) => {
next()
},
// more middleware can be added here..
// (middleware C, middleware D, etc.)
// last function is the final request handler
async (ctx) => {
ctx.body = 'hi'
})
// alternatively if you have a your middleware defined in an array, you can do
router.post('path', ...middleware, finalHandler)
```
To use the router with a `koa` app instance, pass it the function returned by `getRequestHandler`:
```js
app.use(router.getRequestHandler())
```