koa-path

Koa Path

Minimalistic router based on path-to-regexp and path-match. Does not handle methods, just URL routing.

var route = require('koa-path')()

app.use(route('/:user/:repo/:version/component.json', function* onComponentJSON() {
  // do stuff
}))

API

var route = require('koa-path')([options])

options are the options for path-to-regexp

app.use(route(path, fn))

path is the path to be passed to path-to-regexp. fn is a generator function middleware.

this.params

params is updated with any named parameters you update to path. Note that parameters are not removed or deleted after exiting a route, so this.params = {} if you want to reset it.

License

(The MIT License)

Copyright (c) 2014 segmentio <[e-mail]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.