# @appolo/router

> fast routing

Latest version **8.0.2** (published 2020-09-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @appolo/router
pnpm add @appolo/router
yarn add @appolo/router
bun add @appolo/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 | 8.0.2 |
| Published | 2020-09-13 |
| First published | 2020-09-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 8.4.x |
| Dependencies | 1 |
| Unpacked size | 46.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Roman Svichar |
| Maintainers | shmoop207 |
| Keywords | route, router, fast, appolo |

## Links

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

## Dependencies (1)

- [path-to-regexp](https://npm.io/package/path-to-regexp.md) ^6.1.0

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

- 8.0.2 (latest) — 2020-09-13
- 8.0.1 — 2020-09-06
- 8.0.0 — 2020-09-06

## README

# Appolo Route
[![Build Status](https://travis-ci.org/shmoop207/appolo-route.svg?branch=master)](https://travis-ci.org/shmoop207/appolo-route) [![Dependencies status](https://david-dm.org/shmoop207/appolo-route.svg)](https://david-dm.org/shmoop207/appolo-route) [![NPM version](https://badge.fury.io/js/appolo-route.svg)](https://badge.fury.io/js/appolo-route)  [![npm Downloads](https://img.shields.io/npm/dm/appolo-route.svg?style=flat)](https://www.npmjs.com/package/appolo-route)
[![Known Vulnerabilities](https://snyk.io/test/github/shmoop207/appolo-route/badge.svg)](https://snyk.io/test/github/shmoop207/appolo-route)

Fast and simple http routing using radix tree

## Installation:

```javascript
npm install appolo-route --save
```

## Usage:

```javascript
import {Router} from "appolo-route"

let router = new Router()
    .get("/test/:param", ()=>"working");

    output = router.find("GET" , "/test/test2");

    console.log(output.params.param) // test2
    console.log(output.handler()) // working

```

## Router
Options
- `useCache` - cache the find result by path, default : `true`
- `maxCacheSize` -  The maximum size of the cache routes, default: `1000`
- `decodeUrlParams` - true to decodeURIComponent params value, default: `false`

### Static route
```javascript

let router = new Router()
    .get("/test/test2", ()=>"working");
    .post("/test/test2", ()=>"working post");

```
### Parametric route
```javascript

let router = new Router()
    .get("/test/:userId/:userName", ()=>"working");
```
### Wildcard route
```javascript

let router = new Router()
.get("/*", ()=>"working");
```

### Regex route
same syntax as [path-to-regexp](https://github.com/pillarjs/path-to-regexp)
```javascript

let router = new Router()
.get("/test/:file(^\\d+).png", ()=>"working");
```
## Api

#### find(method: Http.Methods, path: string): { params: Params, handler: any }
find route by path return object with `params` and `handler`
if no `params` found return empty object

```javascript
import {Router} from "appolo-route"

let router = new Router()
    .get("/users/:userId", (userId)=>console.log(userId));

    result = router.find("GET" , "/users/123");

    result.handler(result.params.userId) // 123

```

#### get(path: string, handler: any): Router
register new Route handler using Http.Get Method

#### post(path: string, handler: any): Router
register new Route handler using Http.Post Method
#### put(path: string, handler: any): Router
register new Route handler using Http.Put Method
#### patch(path: string, handler: any): Router
register new Route handler using Http.Put Method
#### patch(path: string, handler: any): Router
register new Route handler using Http.Patch Method
#### delete(path: string, handler: any): Router
register new Route handler using Http.Delete Method
#### head(path: string, handler: any): Router
register new Route handler using Http.Delete Method


#### add(method:Http.Methods | Http.Methods[], path: string, handler: any): Router
register new Route handler.
multi methods supported
```javascript

let router = new Router()
    .add(["POST","GET"],"/test/:param", ()=>"working");
```

#### remove(method:Http.Methods | Http.Methods[], path: string): Router
remove Route by path.
multi methods supported
```javascript

let router = new Router()
    .add(["POST","GET"],"/test/:param", ()=>"working")
    .remove("Get","/test/:param");
```

#### reset()
reset the router remove all routes
## License
MIT

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