JSPM

  • Created
  • Published
  • Downloads 421725
  • Score
    100M100P100Q175635F
  • License MIT

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

Package Exports

  • koa-router
  • koa-router/lib/layer
  • koa-router/lib/layer.js
  • koa-router/lib/router.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (koa-router) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@koa/router

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

build status code style styled with prettier made with lass license

Table of Contents

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
Imed Jaberi

License

MIT © Alex Mingoia