https://github.com/blakeembrey/kroute

Modular Koa router middleware with Express-style routes and middleware mounting
https://github.com/blakeembrey/kroute

Last synced: 2 months ago
JSON representation

Modular Koa router middleware with Express-style routes and middleware mounting

• Host: GitHub
• URL: https://github.com/blakeembrey/kroute
• Owner: blakeembrey
• License: mit
• Created: 2014-03-17T14:33:26.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-09-06T09:36:35.000Z (almost 7 years ago)
• Last Synced: 2024-04-14T10:34:14.688Z (3 months ago)
• Language: JavaScript
• Size: 20.5 KB
• Stars: 15
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-koa - kroute - 模块化 Koa 路由器中间件，带有 Express 风格的路由和中间件挂载。   (仓库 / 中间件)

README

        
# Kroute

[![NPM version][npm-image]][npm-url]

[![NPM downloads][downloads-image]][downloads-url]

[![Build status][travis-image]][travis-url]

[![Test coverage][coveralls-image]][coveralls-url]

Modular Koa router middleware with Express-style routes and middleware mounting.

## Install

```

npm install kroute --save

```

## Usage

Kroute exports a function which can be used to create router instances that work with Koa middleware.

```js

var koa = require('koa')

var kroute = require('kroute')

var app = koa()

var router = kroute()

app.use(router)

```

### Initialization

A router can be initialized with default handlers based on a resourceful routing object.

```js

router({

  use: authorizeUser(),

  index: function* () {},

  create: [function* () {}, function* () {}]

})

```

Actions are mapped as follows:

```

GET     /                 ->  index

GET     /new              ->  new

POST    /                 ->  create

GET     /:id              ->  show

GET     /:id/edit         ->  edit

PUT     /:id              ->  update

DELETE  /:id              ->  destroy

```

The object can also contain a `use` property which is mounted before any routes.

### Routes

Every router instance can used to attach request handlers.

```js

router.get('/user', function* () {})

```

Omitting the path name will ensure the handler is always executed when the method matches.

```js

router.post(function* () {})

```

Every route method accepts multiple middleware handlers.

```js

router.delete(authorizeUser(), function* () {})

```

### All Methods

Every router provides a `.all` method for attaching request handlers to every method.

```js

router.all(function* () {})

```

It accepts a path and multiple middleware like any other method.

```js

router.all('/', authorizeUser(), function* () {})

```

### Mounting Middleware

Every router comes with the ability to mount middleware and handlers.

```js

var mount = kroute()

router.use('/users', mount)

```

As long as the middleware follows the Koa generator pattern, it can be mounted.

```js

router.use('/users', function* (next) {

  console.log(this.url) //=> "/123" -> Stripped the route prefix.

  yield next

})

```

Like other methods, `.use` also accepts multiple request handlers and an optional path.

```js

router.use(authorizeUser(), function* () {})

```

### Params

Every path can be dynamic and use Express-style parameter notation.

```js

router.get('/:user', function* () {

  console.log(this.params.user) //=> "123"

})

```

Every match is stored in the params as an object.

```js

router.get('/:foo/:bar', function* () {

  console.log(this.params) //=> { foo: "123", bar: "456" }

})

```

The route can also be a regular expression.

```js

router.get(/^\/blog\/(\d{4})-(\d{2})-(\d{2})\/?$/i, function* (next) {

  console.log(this.params) // => { 0: '2014', 1: '03', 2: '17' }

})

```

### Chaining

Every method returns it's own instance, so routes can be chained together like Express.

```js

router

  .get('/foo', function* () {})

  .post('/bar', function* () {})

```

### Options

Every method accepts an options object as the last argument.

```js

router.get('/foo', function* () {}, { strict: true, sensitive: true })

```

## License

MIT

[npm-image]: https://img.shields.io/npm/v/kroute.svg?style=flat

[npm-url]: https://npmjs.org/package/kroute

[downloads-image]: https://img.shields.io/npm/dm/kroute.svg?style=flat

[downloads-url]: https://npmjs.org/package/kroute

[travis-image]: https://img.shields.io/travis/blakeembrey/kroute.svg?style=flat

[travis-url]: https://travis-ci.org/blakeembrey/kroute

[coveralls-image]: https://img.shields.io/coveralls/blakeembrey/kroute.svg?style=flat

[coveralls-url]: https://coveralls.io/r/blakeembrey/kroute?branch=master