Skip to content

bttmly/koa-route-respond

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

86 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

koa-route-respond

Route middleware for Koa with response object support. Fork of koa-route.

const r = require('koa-route-respond');
app.use(r.get('/pets', pets.list));
app.use(r.get('/pets/:name', pets.show));

Installation

$ npm install koa-route-respond

Example

Contrived resource-oriented example:

const r = require('koa-route');
const { Ok, NotFound } = require('response-objects');
const Koa = require('koa');
const app = new Koa();

const db = {
  tobi: { name: 'tobi', species: 'ferret' },
  loki: { name: 'loki', species: 'ferret' },
  jane: { name: 'jane', species: 'ferret' },
};

const pets = {
  list (ctx) {
    const names = Object.keys(db);
    return Ok(`pets: ${names.join(', ')}`);
  },

  show (ctx, {name}) {
    const pet = db[name];
    if (!pet) throw NotFound('cannot find that pet');
    return Ok(`${pet.name} is a ${pet.species}`);
  },
};

app.use(r.get('/pets', pets.list));
app.use(r.get('/pets/:name', pets.show));
app.listen(3000);

License

MIT

About

`response-objects`-compatible routing middleware for Koa v2

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published