Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/popomore/koa-proxy
Proxy middleware for koa
https://github.com/popomore/koa-proxy
koa proxy
Last synced: 4 months ago
JSON representation
Proxy middleware for koa
- Host: GitHub
- URL: https://github.com/popomore/koa-proxy
- Owner: popomore
- Archived: true
- Created: 2014-03-25T07:59:25.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2019-07-23T09:59:19.000Z (over 5 years ago)
- Last Synced: 2024-09-26T16:40:21.152Z (4 months ago)
- Topics: koa, proxy
- Language: JavaScript
- Size: 41 KB
- Stars: 223
- Watchers: 4
- Forks: 102
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: HISTORY.md
Awesome Lists containing this project
README
# koa-proxy is been transfered to [edorivai](https://www.npmjs.com/~edorivai)
# koa-proxy [](https://travis-ci.org/popomore/koa-proxy) [](https://coveralls.io/r/popomore/koa-proxy?branch=master)
Proxy middleware for koa
---
## Install
```
$ npm install koa-proxy -S
```
## Usage
When you request http://localhost:3000/index.js, it will fetch http://alicdn.com/index.js and return.
```js
var koa = require('koa');
var proxy = require('koa-proxy');
var app = koa();
app.use(proxy({
host: 'http://alicdn.com'
}));
app.listen(3000);
```
You can proxy a specified url.
```js
app.get('index.js', proxy({
url: 'http://alicdn.com/index.js'
}));
```
You can specify a key/value object that can map your request's path to the other.
```js
app.get('index.js', proxy({
host: 'http://alicdn.com',
map: {
'index.js': 'index-1.js'
}
}));
```
You can specify a function that can map your request's path to the desired destination.
```js
app.get('index.js', proxy({
host: 'http://alicdn.com',
map: function(path) { return 'public/' + path; }
}));
```
You can specify match criteria to restrict proxy calls to a given path.
```js
app.use(proxy({
host: 'http://alicdn.com', // proxy alicdn.com...
match: /^\/static\// // ...just the /static folder
}));
```
Or you can use match to exclude a specific path.
```js
app.use(proxy({
host: 'http://alicdn.com', // proxy alicdn.com...
match: /^(?!\/dontproxy\.html)/ // ...everything except /dontproxy.html
}));
```
Proxy won't send cookie to real server, you can set `jar = true` to send it.
```js
app.use(proxy({
jar: true,
}));
```
Proxy won't send 'foo' and 'bar' headers to real server, or recieve 'jar-jar' from real server.
```js
app.use(proxy({
suppressRequestHeaders: ['foo','bar'], // case-insensitive
suppressResponseHeaders: ['jar-jar'] // case-insensitive
}));
```
## LICENSE
Copyright (c) 2014 popomore. Licensed under the MIT license.