# superagent-cors-proxy

> superagent extension to perform CORS requests via an iframe proxy

Latest version **0.0.1** (published 2014-08-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install superagent-cors-proxy
pnpm add superagent-cors-proxy
yarn add superagent-cors-proxy
bun add superagent-cors-proxy
```

## 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.0.1 |
| Published | 2014-08-11 |
| First published | 2014-08-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | @nrako |
| Maintainers | nrako |
| Keywords | superagent, cors, proxy, XDomainRequest |

## Links

- npm: https://www.npmjs.com/package/superagent-cors-proxy
- Repository: https://github.com/nrako/superagent-cors-proxy
- Issues: https://github.com/nrako/superagent-cors-proxy/issues
- npm.io page: https://npm.io/package/superagent-cors-proxy

## Recent versions

- 0.0.1 (latest) — 2014-08-11

## README

superagent-cors-proxy
=====================

Superagent extension to perform CORS requests via an iframe proxy for old IE :gun:.

XDomainRequest === :poop:

This will automatically proxy all cross-domain requests via a proxy. This use postMessage to communicate to the iframe/parent passed in argument.

## Notes

It doesn't supports multiple proxy/iframe yet. Hence, multiple cross-domain urls.

It won't try to perform CORS, it's your duty to use that only when it's necessary.

## Usage

### Shim Client

In a shim IE <10 version.

```javascript
var request     = require('superagent');
var iframe = document.createElement('iframe');
var proxy = require('superagent-cors-proxy')(request, iframe);

proxy.onReady(function () {
  // proxied superagent ready
}.bind(this));

iframe.src = 'https://api.example.com/proxy/';
iframe.setAttribute('style', 'display:none;');
document.body.appendChild(iframe);
```

### Javascript file to add to proxy page

```javascript
var request = require('superagent');

require('superagent-cors-proxy')(request, null, window.parent);

```

## License

MIT

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