# midd-router

> router middleware for midd

Latest version **0.1.4** (published 2017-02-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install midd-router
pnpm add midd-router
yarn add midd-router
bun add midd-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.1.4 |
| Published | 2017-02-22 |
| First published | 2017-02-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Tian Jian |
| Maintainers | kiliwalk, tianjianchn |
| Keywords | midd, router, route |

## Links

- npm: https://www.npmjs.com/package/midd-router
- Repository: https://github.com/tianjianchn/midd/tree/master/packages/midd-router
- Issues: https://github.com/tianjianchn/midd/issues
- npm.io page: https://npm.io/package/midd-router

## Dependencies (2)

- [uni-router](https://npm.io/package/uni-router.md) ^0.1.4
- [midd-express-middlewares](https://npm.io/package/midd-express-middlewares.md) ^0.1.3

## 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.1.4 (latest) — 2017-02-22
- 0.1.3 — 2017-02-22
- 0.1.2 — 2017-02-18
- 0.1.1 — 2017-02-10
- 0.1.0 — 2017-02-09

## README

# Router middleware for midd

### Features
* Support `use()` `all()` `get()` `post()` and other http verbs
* Support url pattern like express router: `use('/:name', ...)`
* Support url rewrite in route
* Support nested routers
* Routes are also promise-based
* Support express middlewares by `router.express.VERB()`

### Usage
```js
const middRouter = require('midd-router');

const router = middRouter();
router.use('/a', async (req, resp, next)=>{
  await next();
})
router.get('/b', (req, resp, next)=>{
  return new Promise((resolve, reject)=>{
    setTimeout(resolve, 1000);
  }).then(next)
})
router.express.use(compression());
app.use(router)
```

### API
#### middRouter(options)
Options have:
* params: object. The default params for `req.params`.

#### router.use|all|get|post|...([pattern], ...middlewares)
Attach routes to the pattern. If no pattern specified, they will be attached at root path('/').

#### router.express.use|all|get|post|...([pattern], ...middlewares)

#### req.params
If the pattern used in router verbs have named part(like '/:name'), `req.params` will contain the named part and its value. 

#### req.routePath
`req.routePath` represents current route's context(or position).
 See there are router A and router B, and their relations are described by
 `routerA.use('/a', routerB)`. So `router B's routePath` = `router A's routePath` + `/a`.

### License

Licensed under MIT

Copyright (c) 2017 [Tian Jian](https://github.com/tianjianchn)

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