# reg-router

> simple regex router

Latest version **1.0.1** (published 2017-09-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install reg-router
pnpm add reg-router
yarn add reg-router
bun add reg-router
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2017-09-21 |
| First published | 2017-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | lrlna |

## Links

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

## Recent versions

- 1.0.1 (latest) — 2017-09-21

## README

# reg-router
[![npm version][2]][3] [![downloads][8]][9] [![js-standard-style][10]][11]

Just your reg router to match routes based on provided regex.

## Usage 

```
var router = require('reg-router')()

router.route(/^\/reset$/, function (req, res, params) {
  res.writeHead(200, 'reset route is hit', { 'content-encoding': 'application/json' })
}

http.createServer(function (req, res) {
  router.match(req, res)
}).listen(8080)
```

# API

## router = new Router()
Creates a new instance off reg-router.

## router.route(regex, handler)
Register a new route. Handler is generally `req, res, params`. 

## router.default(handler)
Defaults to sending back a 404, but you can provide your own default. `router.default` will do this for you.

## router.match(req, res)
Match requests to registered routes. Would usually use when server's fired up. 


# Related content:
- [bankai](https://github.com/choojs/bankai)
- [choo](https://github.com/choojs/choo)

# License
[MIT](https://tldrlegal.com/license/mit-license)

[2]: https://img.shields.io/npm/v/reg-router.svg?style=flat-square
[3]: https://npmjs.org/package/reg-router
[8]: http://img.shields.io/npm/dm/reg-router.svg?style=flat-square
[9]: https://npmjs.org/package/reg-router
[10]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square
[11]: https://github.com/feross/standard

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