koa-my-way

Adaptation of find-my-way that uses koa middlewares. Also, it can import routes defined by route-imperator.

Installation

1npm install --save koa-my-way

Example

1const koa = require('koa')
2const router = require('koa-my-way')()
3
4router.on('GET', '/', (ctx, next) => {
5  ctx.body = '{"message":"hello world"}'
6})
7
8koa.use(router.middleware());

Modified API

router.on(method, path, [opts,] ...handlers[, store])

Defines a route, there are also shorthand methods available. Since koa already provides state management using ctx, using store is discouraged.

1
2router.on('GET', '/', searchPhotos);
3router.on('GET', '/:id', findPhoto);
4router.on('POST', '/d', verifyLoggedIn, uploadPhoto);
5
6// Equivalent calls using shorthand methods
7router
8.get('/', searchPhotos)
9.get('/:id', findPhoto)
10.post('/', verifyLoggedIn, uploadPhoto)
11

router.load(routes)

Load routes declared with route-imperator or from another instance of koa-my-way.

1
2// routes/messages.js
3
4const routes = require('route-imperator')()
5
6routes.use(verifyLoggedIn)
7
8routes
9.get('/', )
10.get('/:id', )
11
12module.exports = routes
13
14
15// routes/index.js
16
17const routes = require('route-imperator')()
18
19const users = require('./users');
20const messages = require('./messages');
21
22// Nest routes using a path prefix
23routes.load('/users', users)
24routes.load('/messages', messages)
25
26module.exports = routes
27
28
29// router.js
30
31const router = require('koa-my-way')()
32const routes = require('./routes')
33
34router.load(routes);
35
36module.exports = router;

router.lookup(ctx, next)

Finds a route and executes handlers.

1koa.use((ctx, next) => {
2  return router.lookup(ctx, next)
3});

router.middleware()

Creates a koa middleware. It's a wrapper for lookup.

1koa.use(router.middleware());

Remaining methods

The remaining methods are untouched, go to find-my-way for more information.