2.0.2 • Published 8 years ago

koa-router-param v2.0.2

Weekly downloads
47
License
MIT
Repository
github
Last release
8 years ago

koa-router-param

Params Router middleware for koa-router

Installation

Install using npm:

npm install koa-router-param

API Reference

KoaRouterParam(params) ⇒ Generator

Creates a middleware for koa-router route.

Parameters

ParamTypeDescription
paramsObjectAn object representing the processable URL params
↳ keyStringName of the param in the URL
↳ valueGeneratorA transformer for the param's value

Example

Basic usage:

var Router = require('koa-router');
var routerParam = require('koa-router-param');

router
    .get(
        '/users/:userId',
        routerParam({ userId: routerParam.Type.Number }),
        function *(next) {
            console.log(this.params.userId); // => Number(123)
        }
    );

RouterParam.Type.Number ⇒ Generator

Casts the given parameter to Number.

Example

Basic usage:

{ paramName: routerParam.Type.Number }

Contributing

Please submit all issues and pull requests to the emartech/koa-router-param repository!

Tests

Run tests using npm test.

Support

If you have any problem or suggestion please open an issue here.

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago

1.0.0

8 years ago

0.0.3

8 years ago

0.0.2

8 years ago

0.0.1

8 years ago