# 3h-router

> A simple router.

Latest version **2.0.5** (published 2018-09-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install 3h-router
pnpm add 3h-router
yarn add 3h-router
bun add 3h-router
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.5 |
| Published | 2018-09-07 |
| First published | 2018-02-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 15.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | 3h |
| Maintainers | 3h |
| Keywords | router, route, server, 3h |

## Links

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

## 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

- 2.0.5 (latest) — 2018-09-07
- 2.0.4 — 2018-07-07
- 2.0.3 — 2018-06-23
- 2.0.2 — 2018-06-23
- 2.0.1 — 2018-06-23
- 1.8.1 — 2018-03-08
- 1.8.0 — 2018-02-20
- 1.7.0 — 2018-02-12
- 1.6.0 — 2018-02-10
- 1.5.3 — 2018-02-10
- 1.5.2 — 2018-02-09
- 1.5.1 — 2018-02-08
- 1.5.0 — 2018-02-07
- 1.4.2 — 2018-02-07
- 1.4.1 — 2018-02-05
- … 11 more at https://npm.io/package/3h-router/versions

## README

# 3h-router

A simple router lib.

# Features

- Gzip/Deflate support
- Main router and sub-routers

# Example

## main router

```javascript

const Router = require('3h-router'),
    router = new Router({ basePath: __dirname });

// You can get default values via Router.defaultOptions.
router.defaultPages.unshift('my-default-page.html');
router.subRouters.unshift('my-sub-router.js');

router.on('before', url => {
    console.log(`[before] ${url}`);
    // If there's any `before` event handler, then
    // the routing will pause here, so remember to
    // call router.route to continue the routing.
    // In addition, if you want to forward the
    // request, then just pass the target url.
    router.route(url);
}).on('result', result => {
    console.log(`[result] ${result.code}`);
}).on('error', err => {
    console.log('An error occurred!');
    console.error(err);
}).start(88);

console.log('Server started on port 88!');

```

## sub-router

```javascript

module.exports = router => {
    const { response } = router;
    response.writeHead(200, {
        'Content-Type': 'text/html'
    });
    response.end('<h1>Generated by sub-router!</h1>');
};

```

# APIs

Just read the declaration files in [`typings`](typings) to learn the APIs.

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