# route-r

> Lite HTTP Request routing and serving framework

Latest version **0.1.0** (published 2024-03-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install route-r
pnpm add route-r
yarn add route-r
bun add route-r
```

Provides the command `route-r`.

## 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.0 |
| Published | 2024-03-16 |
| First published | 2015-02-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 70.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Rajendra Patil |
| Maintainers | rpatil26 |
| Keywords | router, server, lite |

## Links

- npm: https://www.npmjs.com/package/route-r
- Repository: https://github.com/rpatil26/npm-route-r
- Issues: https://github.com/rpatil26/npm-route-r/issues
- npm.io page: https://npm.io/package/route-r

## 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.0 (latest) — 2024-03-16
- 0.0.6 — 2015-03-04
- 0.0.5 — 2015-03-04
- 0.0.4 — 2015-03-02
- 0.0.3 — 2015-02-18
- 0.0.2 — 2015-02-17
- 0.0.1 — 2015-02-17

## README

# npm-route-r
Lite HTTP Request routing and serving framework for Node

# Usage
**Handle GET requests**
```js
var server = require("route-r").server;

server.onGet("/something", function(req, res) {
  return {
    headers: {"Content-Type":"application/json"}
    data: {"key":"value"}
  };
});

server.start(9898);
```
**Extract path variables**
```js
//...
server.onGet("/user/:id", function(req, res) {
  var userId = req.params.id;
  //...
});
//...
```
**Extract query parameters**
```js
//...
server.onGet("/users/search", function(req, res) { //users/search?name=john&city=sf
  var name = req.params.name, // john
      city = req.params.city //sf
  //...
});
//...
```
**Handle POST requests**
```js
//...
server.onPost("/user/add", function(req, res) { 
  var user = req.body; // exctract JSON body (get JSON if req content-type is application/json)
  //...
});
//...
```
**Return any custom headers**
```js
//...
server.onGet("/users/list", function(req, res) { 
  return {
    headers: {"X-Served-By": "route-r"}
  };
  //...
});
//...
```
**Return custom error code and message**
```js
//...
server.onGet("/users/list", function(req, res) { 
  return {
    code: 401,  //Not authorized
    message: "No any valid token found" //custom message
  };
  //...
});
//...
```
**Force file download**
```js
//...
server.onGet("/users/list/download", function(req, res) { 
  return {
    downloadAs: "users-list.txt",
    data: "......"
  };
  //...
});
//...
```

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