Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 1.72 KB

README.md

File metadata and controls

54 lines (39 loc) · 1.72 KB
Raw

koay-router

NPM package

Note: Provide a faster router for Koa, and support configurable routes for Koa or express.

NPM version NPM Downloads

Router middleware for koa

  • Express-style routing using app.get, app.put, app.post, etc.
  • Named URL parameters.
  • Named routes with URL generation.
  • Multiple route middleware.
  • Multiple routers.
  • Nestable routers.
  • ES7 async/await support.

Installation

Install using npm:

npm install koay-router --save

API Reference

  • koay-router

    • Router

      • new Router([opts])

        • instance

          • .get|put|post|patch|delete|del ⇒ Router
          • .routes ⇒ function
          • .use([path], middleware)] ⇒ Router
          • .prefixWith(prefix) ⇒ Router
          • .redirect(source, destination, [code]) ⇒ Router
          • .route(name) ⇒ Route | null
          • .url(name, params, [options]) ⇒ String

        • static

          • .url(path, params, [options]) ⇒ String

    • Controller

      • new Controller([opts])
        • instance
          • routes ⇒ function

Examples