https://github.com/segment-boneyard/koa-params

Add express style params support to koa
https://github.com/segment-boneyard/koa-params

Last synced: about 5 hours ago
JSON representation

Add express style params support to koa

• Host: GitHub
• URL: https://github.com/segment-boneyard/koa-params
• Owner: segment-boneyard
• Created: 2014-01-22T12:55:28.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2014-04-12T19:17:18.000Z (over 10 years ago)
• Last Synced: 2024-05-19T04:49:18.268Z (6 months ago)
• Language: JavaScript
• Size: 179 KB
• Stars: 26
• Watchers: 41
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • Changelog: History.md

Awesome Lists containing this project

README

        

# koa-params

  Add express style [params](http://expressjs.com/api.html#app.param)

support to [koa-route](https://github.com/koajs/route).

  [![build status](https://secure.travis-ci.org/segmentio/koa-params.png)](http://travis-ci.org/segmentio/koa-params)

## Example

```js

var koa = require('koa');

var route = require('koa-route')

var paramify = require('koa-params');

route = paramify(route);

var param = route.param;

var get = route.get;

var app = koa();

// fake db

var users = {

  'julian': { name: 'Julian Gruber', fun: true },

  'badguy': { name: 'Bad Guy', fun: false }

};

param('user', function*(id, next){

  var user = users[id];

  if (!user) return this.status = 404;

  this.user = user;

  yield next;

});

app.use(get('/', function*(){

  this.body = Object.keys(users);

}));

app.use(get('/:user', function*(){

  this.body = this.user;

}));

app.listen(3000);

```

## Installation

```bash

$ npm install koa-params

```

## API

### paramify(route)

  Return a cloned version of `route` with http verbs patched and added `.param`.

### route.param(param, fn)

  When a route contains `:param`, call `fn` with its value and `next`. Wait for it to yield before continuing with the real route handler - unless you don't yield and the response ends.

  You can register multiple `fns` per `param`, just as with express.

  

  `fn` can be koa middleware too, when `fn` only takes one argument, `next` will be supplied.

## License

  MIT