koajs / router

Router middleware for Koa. Maintained by @forwardemail and @ladjs.

@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:

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

License

MIT © Alex Mingoia