# ussd-router

> A free utility for easy routing in USSD applications

Latest version **0.1.6** (published 2021-07-28) · GPL-3.0 license · 0 weekly downloads

## Install

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

## 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.6 |
| Published | 2021-07-28 |
| First published | 2019-11-22 |
| Weekly downloads | 0 |
| License | GPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10.3.0 |
| Dependencies | 0 |
| Unpacked size | 45.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 9 |
| Author | Tony |
| Maintainers | tawn33y |
| Keywords | ussd, navigation, util, africastalking, africas talking, sdk |

## Links

- npm: https://www.npmjs.com/package/ussd-router
- Repository: https://github.com/tawn33y/ussd-router
- Issues: https://github.com/tawn33y/ussd-router/issues
- npm.io page: https://npm.io/package/ussd-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

- 0.1.6 (latest) — 2021-07-28
- 0.1.5 — 2020-02-12
- 0.1.4 — 2020-01-29
- 0.1.3 — 2019-11-28
- 0.1.2 — 2019-11-22
- 0.1.1 — 2019-11-22

## README

# ussd-router

[![build, run linter & tests](https://github.com/tawn33y/ussd-router/actions/workflows/main.yml/badge.svg)](https://github.com/tawn33y/ussd-router/actions/workflows/main.yml)
![npm](https://img.shields.io/npm/v/ussd-router)
![npm bundle size](https://img.shields.io/bundlephobia/min/ussd-router)
![npm](https://img.shields.io/npm/dw/ussd-router)

`ussd-router` is a free utility for easy routing in USSD applications.

## Install

```bash
npm i ussd-router
```

See also:

- [the blog for a detailed description](https://dev.to/tawn33y/a-free-utility-for-easy-routing-in-ussd-applications-3b6j).
- [the source code for the algorithm used](https://github.com/tawn33y/ussd-router/blob/main/src/index.ts).

## Example usage (simple)

```js
import { ussdRouter } from 'ussd-router';

const text1 = ussdRouter('544*1*2'); // '544*1*2'
const text2 = ussdRouter('544*1*2*00*3'); // '544*1*3'
const text3 = ussdRouter('544*1*2*0*1*2'); // '1*2'
const text4 = ussdRouter('544*1*2*0*1*2*00*3'); // '1*3'
```

## Example usage (with express)

```js
import express from 'express';
import { ussdRouter } from 'ussd-router';

// ...

app.post('/webhook/ussd', (req, res) => {
  const { body: { text: rawText } } = req;

  const text = ussdRouter(rawText);

  if (text === '1') {
    res
      .status(200)
      .send('View: \n1. My account number \n2. My balance');
  }

  // ...
});
```

## Dev

```bash
# install dependencies
npm i

# build
npm run build

# lint
npm run lint

# test
npm t
```

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