# koa-simple-router

> Simple router for koa 2.x

Latest version **0.2.0** (published 2015-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install koa-simple-router
pnpm add koa-simple-router
yarn add koa-simple-router
bun add koa-simple-router
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2015-11-07 |
| First published | 2015-10-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | gyson |
| Maintainers | gyson |
| Keywords | koa, route, router, middleware |

## Links

- npm: https://www.npmjs.com/package/koa-simple-router
- Repository: https://github.com/gyson/koa-simple-router
- Homepage: https://github.com/gyson/koa-simple-router#readme
- Issues: https://github.com/gyson/koa-simple-router/issues
- npm.io page: https://npm.io/package/koa-simple-router

## Dependencies (3)

- [methods](https://npm.io/package/methods.md) ^1.1.1
- [koa-compose](https://npm.io/package/koa-compose.md) ^3.0.0
- [path-to-regexp](https://npm.io/package/path-to-regexp.md) ^1.2.1

## Alternatives

- [express-promise-router](https://npm.io/package/express-promise-router.md) — 736.1K weekly downloads
- [next-usequerystate](https://npm.io/package/next-usequerystate.md) — 29.8K weekly downloads
- [@bitkyc08/opencodex](https://npm.io/package/@bitkyc08/opencodex.md) — 4.6K weekly downloads
- [lynkr](https://npm.io/package/lynkr.md) — 575 weekly downloads
- [baremetal.js](https://npm.io/package/baremetal.js.md) — 42 weekly downloads

## Recent versions

- 0.2.0 (latest) — 2015-11-07
- 0.1.1 — 2015-11-05
- 0.1.0 — 2015-11-05
- 0.0.3 — 2015-10-30
- 0.0.2 — 2015-10-30
- 0.0.1 — 2015-10-29

## README

# koa-simple-router

[![npm version](https://img.shields.io/npm/v/koa-simple-router.svg)](https://npmjs.org/package/koa-simple-router)
[![build status](https://travis-ci.org/gyson/koa-simple-router.svg)](https://travis-ci.org/gyson/koa-simple-router)

Simple and fast router for [koa](https://github.com/koajs/koa) 2.x

## Features

* support prefix
* support auto OPTIONS and 405 response
* use [`path-to-regexp`](https://github.com/pillarjs/path-to-regexp) to parse url
* use express style routing ( `.get`, `.put`, `.post`, `.all`, etc )
* use loop to iterate through multiple routes instead of recursive calls
  * better performance
  * prevent max call stack error with large number of routes

## Installation

```
$ npm install koa-simple-router
```

## Usage

```js
const Koa = require('koa') // koa 2.x
const router = require('koa-simple-router')

let app = new Koa()

app.use(router(_ => {
  _.get('/', (ctx, next) => {
    ctx.body = 'hello'
  })
  _.post('/name/:id', (ctx, next) => {
    // ...
  })
})
```

## API

### `router(init)`

Create a router middleware with init function.

```js
const Koa = require('koa')
const router = require('koa-simple-router')
const app = new Koa()

app.use(router(_ => {
  _.get('/', (ctx, next) => {

  })
  _.post('/path', (ctx, next) => {

  })
}))
```

### `router(options, init)`

Create a router middleware with options and init function.

Default options is the same as [`path-to-regexp`](https://github.com/pillarjs/path-to-regexp).

- **prefix** (default: `null`)
- **sensitive** (default: `false`)
- **strict** (default: `false`)
- **end** (default: `true`)

```js
const Koa = require('koa')
const router = require('koa-simple-router')
const app = new Koa()

app.use(router({ prefix: '/api' }, _ => {
  _.get('/:user/id', (ctx, next) => {

  })
  _.post('/:user/id', (ctx, next) => {

  })
}))
```

### `_.verb(path, ...mw)`

```js
app.use(router(_ => {
  _.get('/path',
    (ctx, next) => {},
    (ctx, next) => {},
    (ctx, next) => {}
  )
}))
```

### `_.all(path, ...[mw | obj])`

Middleware mode: works just like `_.verb(path, ...mw)` but ignore `ctx.method`

```js
app.use(router(_ => {
  _.all('/path/to/:recource', (ctx, next) => {

  })
}))
```

Object mode: accept an object with method as key and middleware or array of middleware as value

* auto `HEAD` response if `GET` present
* auto `OPTIONS` response with `Allow` header
* auto 405 response with `Allow` header

```js
app.use(router(_ => {
  _.all('/path/to/:recource', {
    get: (ctx, next) => {

    },
    post: (ctx, next) => {

    }
    // Allow: GET, HEAD, POST, OPTIONS
  })
  //
  // you can mix middleware and object
  //
  _.all('/path2/to/:dest', authMiddleware, {
    get: (ctx, next) => {

    },
    post: (ctx, next) => {

    },
    put: (ctx, next) => {

    },
    delete: (ctx, next) => {

    }
    // Allow: GET, HEAD, POST, PUT, DELETE, OPTIONS
  })
}))
```

### `_.param(param, ...mw)`

Register middleware for named route parameters.

```js
app.use(router(_ => {
  _.param('user', async (ctx, next) => {
    ctx.user = await User.find(ctx.params.user)
    // ...
    return next()
  })

  _.get('/:user/do-x', (ctx, next) => {

  })

  _.post('/:user/do-y', (ctx, next) => {

  })
}))

```

## License

MIT

---
_Source: https://npm.io/package/koa-simple-router · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._