@koa/router

Router middleware for koa. Provides RESTful resource routing.

**IMPORTANT 10x+ PERFORMANCE UPGRADE**: Please upgrade to v12.0.1+ as we have fixed an issue with debuglog causing 10x slower router benchmark performance, see https://github.com/koajs/router/pull/173

Last updated 6 years ago by niftylettuce .

MIT · Repository · Bugs · Original npm · Tarball · package.json

$ cnpm install @koa/router

SYNC missed versions from official npm registry.

@koa/router

Router middleware for Koa. Maintained by Forward Email and Lad.

Table of Contents

Features
Migrating to 7 / Koa 2
Install
Typescript Support
API Reference
Contributors
License

Features

Express-style routing (app.get, app.put, app.post, etc.)
Named URL parameters
Named routes with URL generation
Match routes with specific host
Responds to OPTIONS requests with allowed methods
Support for 405 Method Not Allowed and 501 Not Implemented
Multiple route middleware
Multiple and nestable routers
async/await support

Migrating to 7 / Koa 2

The API has changed to match the new promise-based middleware signature of koa 2. See the koa 2.x readme for more information.
Middleware is now always run in the order declared by .use() (or .get(), etc.), which matches Express 4 API.

Install

npm install @koa/router

Typescript Support

npm install --save-dev @types/koa__router

API Reference

See API Reference for more documentation.

Contributors

Name
Alex Mingoia
@koajs
Imed Jaberi

License

MIT © Alex Mingoia

Current Tags

14.0.0 ... latest (8 months ago)

28 Versions

Maintainers (9)

Downloads

Today 0

This Week 0

This Month 0

Last Day 0

Last Week 1

Last Month 1

Dependencies (5)

debug ^4.1.1
http-errors ^1.7.3
koa-compose ^4.1.0
methods ^1.1.2
path-to-regexp ^6.1.0

Dev Dependencies (9)

@ladjs/env ^1.0.0
expect.js ^0.3.1
jsdoc-to-markdown ^5.0.3
koa ^2.11.0
mocha ^7.0.1
nyc ^15.0.0
should ^13.2.3
supertest ^4.0.2
wrk ^1.2.0

Dependents (2)

Copyright 2013 - present © cnpmjs.org | Home |