# koa-rewrite

> URL rewrite middleware for koa

Latest version **3.0.1** (published 2018-05-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install koa-rewrite
pnpm add koa-rewrite
yarn add koa-rewrite
bun add koa-rewrite
```

## 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.0.1 |
| Published | 2018-05-08 |
| First published | 2013-09-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4 |
| Dependencies | 2 |
| Unpacked size | 3.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 98 |
| Maintainers | aheckmann, coderhaoxin, dead_horse, eivifj, fengmk2, jongleberry, juliangruber, tejasmanohar, tjholowaychuk |
| Keywords | koa, middleware, rewrite, redirect, url |

## Links

- npm: https://www.npmjs.com/package/koa-rewrite
- Repository: https://github.com/koajs/rewrite
- Homepage: https://github.com/koajs/rewrite#readme
- Issues: https://github.com/koajs/rewrite/issues
- npm.io page: https://npm.io/package/koa-rewrite

## Dependencies (2)

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

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 3.0.1 (latest) — 2018-05-08
- 1.1.2 (v1) — 2017-08-21
- 2.1.0 (next) — 2016-03-03
- 3.0.0 — 2017-11-03
- 1.1.1 — 2015-10-21
- 1.1.0 — 2014-01-14
- 1.0.0 — 2013-09-09

## README

# [**koa-rewrite**](https://github.com/koajs/rewrite)

> URL rewrite middleware for koa.

___Notice: `koa-rewrite@2+` supports `koa@2`, if you want to use this module with `koa@1`, please use `koa-rewrite@1`.___


## Installation

```js
$ npm install koa-rewrite
```


## Examples

Rewrite using a regular expression, rewriting `/i123` to `/items/123`.

```js
app.use(rewrite(/^\/i(\w+)/, '/items/$1'));
```

Rewrite using route parameters, references may be named or numeric. For example rewrite `/foo..bar` to `/commits/foo/to/bar`:

```js
app.use(rewrite('/:src..:dst', '/commits/$1/to/$2'));
app.use(rewrite('/:src..:dst', '/commits/:src/to/:dst'));
```

You may also use the wildcard `*` to soak up several segments, for example `/js/vendor/jquery.js` would become `/public/assets/js/vendor/jquery.js`:

```js
app.use(rewrite('/js/(.*)', '/public/assets/js/$1'));
```


## Debugging

Use the __DEBUG__ environment variable with "koa-rewrite":

```
koa-rewrite rewrite /i123 -> /items/123 +762ms
koa-rewrite rewrite /i321 -> /items/321 +9s
koa-rewrite rewrite /i123 -> /items/123 +5s
```


## License

[MIT](/LICENSE)

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