JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1341920
  • Score
    100M100P100Q188049F
  • License MIT

Router middleware for koa. Provides RESTful resource routing.

Package Exports

  • @koa/router

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.

NPM version NPM Downloads Node.js Version Build Status gitter

  • Express-style routing (app.get, app.put, app.post, etc.)
  • Named URL parameters
  • Named routes with URL generation
  • 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.

Installation

# npm .. 
npm i @koa/router
# yarn .. 
yarn add @koa/router

API Reference

Contributing

Please submit all issues and pull requests to the koajs/router repository!

Support

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

Call for Maintainers

This module is forked from the original koa-router due to its lack of activity. koa-router is the most widely used router module in the Koa community and we need maintainers. If you're interested in fixing bugs or implementing new features feel free to open a pull request. We'll be adding active contributors as collaborators.

Thanks to the original authors @alexmingoia and the original team for their great work.

License

MIT