koa-route
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/koa-route package

4.0.1 • Public • Published

koa-route

Uber simple route middleware for koa.

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

If you need a full-featured solution check out koa-router, a Koa clone of express-resource.

Installation

$ npm install koa-route

Example

Contrived resource-oriented example:

const _ = require('koa-route');
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);
    ctx.body = 'pets: ' + names.join(', ');
  },

  show: (ctx, name) => {
    const pet = db[name];
    if (!pet) return ctx.throw('cannot find that pet', 404);
    ctx.body = pet.name + ' is a ' + pet.species;
  }
};

app.use(_.get('/pets', pets.list));
app.use(_.get('/pets/:name', pets.show));

app.listen(3000, (err) => {
  if (err) console.error(err.stack);
  else console.log('listening on port 3000');
});

License

MIT

Package Sidebar

Install

npm i koa-route

Weekly Downloads

93,265

Version

4.0.1

License

MIT

Unpacked Size

3.3 kB

Total Files

3

Last publish

Collaborators

  • coderhaoxin
  • aaron
  • juliangruber
  • eivifj
  • travisjeffery
  • dead_horse
  • tjholowaychuk
  • tejasmanohar
  • jongleberry
  • fengmk2