# super-router

> [![Travis build status](https://travis-ci.org/autoric/super-router)](https://travis-ci.org/autoric/super-router.svg)

Latest version **3.2.1** (published 2017-11-10) · 0 weekly downloads

## Install

```sh
npm install super-router
pnpm add super-router
yarn add super-router
bun add super-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 | 3.2.1 |
| Published | 2017-11-10 |
| First published | 2015-10-26 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Maintainers | autoric |

## Links

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

## Dependencies (5)

- [q](https://npm.io/package/q.md) ^1.4.1
- [esdoc](https://npm.io/package/esdoc.md) ^0.4.6
- [lodash](https://npm.io/package/lodash.md) ^4.6.1
- [isstream](https://npm.io/package/isstream.md) ^0.1.2
- [route-parser](https://npm.io/package/route-parser.md) 0.0.4

## Recent versions

- 3.2.1 (latest) — 2017-11-10
- 3.2.0 — 2017-11-09
- 3.1.4 — 2016-07-15
- 3.1.3 — 2016-03-14
- 3.1.2 — 2016-03-10
- 3.1.1 — 2016-03-09
- 3.1.0 — 2016-01-15
- 3.0.0 — 2016-01-12
- 2.0.6 — 2015-11-20
- 2.0.5 — 2015-11-11
- 2.0.4 — 2015-11-05
- 2.0.3 — 2015-10-27
- 2.0.2 — 2015-10-27
- 2.0.1 — 2015-10-26
- 2.0.0 — 2015-10-26

## README

# Super Router

[![Travis build status](https://travis-ci.org/autoric/super-router)](https://travis-ci.org/autoric/super-router.svg)


[API Docs](http://autoric.github.io/super-router/doc/)

[Code coverage Report](http://autoric.github.io/super-router/coverage/lcov-report/)

```
const SuperRouter = require('super-router');
const app      = new SuperRouter.App();
const router   = new SuperRouter.Router();

router.addRoute({
  path    : '/cases',
  methods : 'get',
  handler : (opts) => {
    const request  = opts.request;
    const response = opts.response;

    return Database.getCases().then((cases)=>{
      response.setBody(cases);
    });
  }
});

router.addRoute({
  path    : '/cases/:caseId',
  methods : 'get',
  handler : (opts) => {
    const request  = opts.request;
    const response = opts.response;

    return Database.getCaseById(request.routeParams.caseId).then((case)=>{
      response.setBody(case);
    });
  }
});

app.then({
  path : '/cases/externalId/:externalId(/*restOfRoute)',
  handler : (opts) => {
    const request  = opts.request;
    const response = opts.response;

    return Database.getCaseByExternalId(request.routeParams.externalId).then((case)=>{
      request.path = `/cases/${case.id}${request.routeParams.restOfRoute}`
    });
  }
});
app.then(router.match);
app.then(router.execute);
app.then((opts) => {
  const request  = opts.request;
  const response = opts.response;

  response.setBody(JSON.stringify(response.getBody()));
})

```

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