# egg-router-plus

> The missing router features for eggjs

Latest version **2.0.0** (published 2021-07-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install egg-router-plus
pnpm add egg-router-plus
yarn add egg-router-plus
bun add egg-router-plus
```

## 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.0 |
| Published | 2021-07-12 |
| First published | 2017-12-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12 |
| Dependencies | 3 |
| Unpacked size | 13.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 140 |
| Author | TZ |
| Maintainers | hubcarl, mansonchor.zzw, eggjs-admin, fengmk2, atian25, dead_horse, popomore, wanghx, hyj1991, thonatos, killagu, coolme200, xadillax, ngot |
| Keywords | egg, eggPlugin, egg-plugin, egg-router |

## Links

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

## Dependencies (3)

- [is-type-of](https://npm.io/package/is-type-of.md) ^1.2.1
- [@eggjs/router](https://npm.io/package/@eggjs/router.md) ^2.0.0
- [trie-prefix-tree](https://npm.io/package/trie-prefix-tree.md) ^1.5.1

## 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.0 (latest) — 2021-07-12
- 1.3.1 — 2019-07-01
- 1.3.0 — 2018-09-10
- 1.2.2 — 2018-08-24
- 1.2.1 — 2018-05-29
- 1.2.0 — 2018-01-04
- 1.1.0 — 2017-12-12
- 1.0.0 — 2017-12-11
- 0.0.1 — 2017-12-09

## README

# egg-router-plus

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-router-plus.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-router-plus
[travis-image]: https://img.shields.io/travis/eggjs/egg-router-plus.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-router-plus
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-router-plus.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-router-plus?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-router-plus.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-router-plus
[snyk-image]: https://snyk.io/test/npm/egg-router-plus/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-router-plus
[download-image]: https://img.shields.io/npm/dm/egg-router-plus.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-router-plus

The missing router features for [eggjs](https://eggjs.org)

## Install

```bash
$ npm i egg-router-plus --save
```

Then mount plugin:

```js
// {app_root}/config/plugin.js
exports.routerPlus = {
  enable: true,
  package: 'egg-router-plus',
};
```

## Features

### load `app/router/**/*.js`

this plugin will auto load router define at `app/router/**/*.js`.

**Notice: all sub routers will be loaded before `app/router.js`, please ensure all the sub router definitions are not conflict(better to use `app.router.namespace` to create different namespaces for each sub router file).**

### app.router.namespace

```js
app.router.namespace(prefix, ...middlewares);
```

- `prefix` - {String}, the prefix string of sub router
- `middlewares` - {...Function}, optional group middlewares

Support same as Router:

- `router.verb('path-match', app.controller.action);`
- `router.verb('path-match', middleware1, ..., middlewareN, app.controller.action);`
- `router.verb('router-name', 'path-match', app.controller.action);`
- `router.verb('router-name', 'path-match', middleware1, ..., middlewareN, app.controller.action);`

`prefix` and `path` are not allow to be `regex`, and `prefix` can't be '/'.

```js
// {app_root}/app/router.js
module.exports = app => {
  const subRouter = app.router.namespace('/sub');
  // curl localhost:7001/sub/test
  subRouter.get('/test', app.controller.sub.test);
  subRouter.get('sub_upload', '/upload', app.controller.sub.upload);

  // const subRouter = app.router.namespace('/sub/:id');
  // const subRouter = app.router.namespace('/sub', app.middleware.jsonp());

  // output: /sub/upload
  console.log(app.url('sub_upload'));
};
```

 Every different prefix will bind to different router instance, and all the namespaces will sort by trie tree to ensure best match.

 ```js
 module.exports = app => {
  const apiRouter = app.router.namespace('/api');
  const apiWebRouter = app.router.namespace('/api/web');
  const apiWebAdminRouter = app.router.namespace('/api/web/admin');
  apiRouter.get('/:a/:b/:c', controller.api.one);
  apiWebRouter.get('/:a/:b', controller.api.two);
  apiWebAdminRouter.get('/:a', controller.api.three);
  // /api/web/admin/hello => controller.api.three
  // /api/web/foo/hello => controller.api.two
  // /api/foo/bar/hello => controller.api.one
};
 ```

## Known issues

- sub `redirect` is not support, use `app.router.redirect()` or redirect to a named router.

```js
const subRouter = app.router.namespace('/sub');

// will redirect `/sub/go` to `/anyway`, not `/sub/anyway`
subRouter.redirect('/go', '/anyway');

// just use router
router.redirect('/sub/go', '/sub/anyway');

// or redirect to a named router
subRouter.get('name_router', '/anyway', app.controller.sub.anyway);
// will redirect `/sub/go_name` to `/sub/anyway` which is named `name_router`
subRouter.redirect('/sub/go_name', 'name_router');
```

## Questions & Suggestions

Please open an issue [here](https://github.com/eggjs/egg/issues).

## License

[MIT](LICENSE)

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