# cross-fetch
> Universal WHATWG Fetch API for Node, Browsers and React Native
Latest version **4.1.0** (published 2024-12-21) · MIT license · 0 weekly downloads
> **Better alternative:** See documentation for alternatives (https://github.com/AikidoSec/module-replacements/blob/main/docs/fetch)
## Install
```sh
npm install cross-fetch
pnpm add cross-fetch
yarn add cross-fetch
bun add cross-fetch
```
## Health
**Score 30/100 (F)** — status: maintenance-mode.
Positive: has types; no vulnerabilities.
Warnings: low downloads; no esm support.
Negative: stale; low maintenance score.
## Facts
| | |
|---|---|
| Version | 4.1.0 |
| Published | 2024-12-21 |
| First published | 2017-09-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 91.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1695 |
| Author | Leonardo Quixada |
| Maintainers | lquixada |
| Keywords | fetch, http, url, promise, async, await, isomorphic, universal, node, react, native, browser, ponyfill, whatwg, xhr, ajax |
## Links
- npm: https://www.npmjs.com/package/cross-fetch
- Repository: https://github.com/lquixada/cross-fetch
- Issues: https://github.com/lquixada/cross-fetch/issues
- npm.io page: https://npm.io/package/cross-fetch
## Dependencies (1)
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.7.0
## Alternatives
- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads
- [fa](https://npm.io/package/fa.md) — 185 weekly downloads
## Recent versions
- 4.1.0 (latest) — 2024-12-21
- 3.2.0 (latest-v3.x) — 2024-12-21
- 2.2.6 (latest-v2.x) — 2022-04-10
- 4.0.0 — 2023-07-03
- 4.0.0-alpha.13 — 2023-07-02
- 3.1.8 — 2023-07-02
- 4.0.0-alpha.10 — 2023-07-02
- 3.1.7 — 2023-07-01
- 3.1.7-test.0 — 2023-06-11
- 4.0.0-alpha.5 — 2023-06-02
- 4.0.0-alpha.4 — 2023-06-02
- 3.1.6 — 2023-05-14
- 3.1.5 — 2022-01-20
- 3.2.0-alpha.2 — 2021-10-19
- 3.2.0-alpha.1 — 2021-10-19
- … 36 more at https://npm.io/package/cross-fetch/versions
## README
cross-fetch
[](https://www.npmjs.com/package/cross-fetch)
[](https://www.npmjs.com/package/cross-fetch)
[](https://opensource.org/licenses/MIT)
[](https://github.com/lquixada/cross-fetch/actions/workflows/ci.yml)
[](https://codecov.io/gh/lquixada/cross-fetch)
================
Universal WHATWG Fetch API for Node, Browsers, Workers and React Native. The scenario that cross-fetch really shines is when the same JavaScript codebase needs to run on different platforms.
- **Platform agnostic**: browsers, Node or React Native
- **Optional polyfill**: it's up to you if something is going to be added to the global object or not
- **Simple interface**: no instantiation, no configuration and no extra dependency
- **WHATWG compliant**: it works the same way wherever your code runs
- **TypeScript support**: better development experience with types.
- **Worker support**: works on different types of workers such as Service Workers and CloudFlare Workers
* * *
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Demo \& API](#demo--api)
- [FAQ](#faq)
- [Yet another fetch library?](#yet-another-fetch-library)
- [Why polyfill might not be a good idea?](#why-polyfill-might-not-be-a-good-idea)
- [How does cross-fetch work?](#how-does-cross-fetch-work)
- [Who's Using It?](#whos-using-it)
- [Thanks](#thanks)
- [License](#license)
- [Author](#author)
* * *
## Install
```sh
npm install --save cross-fetch
```
As a [ponyfill](https://github.com/sindresorhus/ponyfill) (imports locally):
```javascript
// Using ES6 modules with Babel or TypeScript
import fetch from 'cross-fetch';
// Using CommonJS modules
const fetch = require('cross-fetch');
```
As a polyfill (installs globally):
```javascript
// Using ES6 modules
import 'cross-fetch/polyfill';
// Using CommonJS modules
require('cross-fetch/polyfill');
```
The CDN build is also available on unpkg:
```html
```
This adds the fetch function to the window object. Note that this is not UMD compatible.
* * *
## Usage
With [promises](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise):
```javascript
import fetch from 'cross-fetch';
// Or just: import 'cross-fetch/polyfill';
fetch('//api.github.com/users/lquixada')
.then(res => {
if (res.status >= 400) {
throw new Error("Bad response from server");
}
return res.json();
})
.then(user => {
console.log(user);
})
.catch(err => {
console.error(err);
});
```
With [async/await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function):
```javascript
import fetch from 'cross-fetch';
// Or just: import 'cross-fetch/polyfill';
(async () => {
try {
const res = await fetch('//api.github.com/users/lquixada');
if (res.status >= 400) {
throw new Error("Bad response from server");
}
const user = await res.json();
console.log(user);
} catch (err) {
console.error(err);
}
})();
```
## Demo & API
You can find a comprehensive doc at [Github's fetch](https://github.github.io/fetch/) page. If you want to play with cross-fetch, check our [**JSFiddle playground**](https://jsfiddle.net/lquixada/3ypqgacp/).
> **Tip**: Run the fiddle on various browsers and with different settings (for instance: cross-domain requests, wrong urls or text requests). Don't forget to open the console in the test suite page and play around.
## FAQ
#### Yet another fetch library?
I did a lot of research in order to find a fetch library that could be simple, cross-platform and provide polyfill as an option. There's a plethora of libs out there but none could match those requirements.
#### Why polyfill might not be a good idea?
In a word? Risk. If the spec changes in the future, it might be problematic to debug. Read more about it on [sindresorhus's ponyfill](https://github.com/sindresorhus/ponyfill#how-are-ponyfills-better-than-polyfills) page. It's up to you if you're fine with it or not.
#### How does cross-fetch work?
Just like isomorphic-fetch, it is just a proxy. If you're in node, it delivers you the [node-fetch](https://github.com/bitinn/node-fetch/) library, if you're in a browser or React Native, it delivers you the github's [whatwg-fetch](https://github.com/github/fetch/). The same strategy applies whether you're using polyfill or ponyfill.
## Who's Using It?
|[](https://www.nytimes.com/)|[](https://github.com/apollographql/apollo-client/)|[](https://github.com/facebook/fbjs/)|[](https://swagger.io/)|[](http://vulcanjs.org)|[](https://github.com/prisma/graphql-request)|
|:---:|:---:|:---:|:---:|:---:|:---:|
|The New York Times|Apollo GraphQL|Facebook|Swagger|VulcanJS|graphql-request|
## Thanks
Heavily inspired by the works of [matthew-andrews](https://github.com/matthew-andrews). Kudos to him!
## License
cross-fetch is licensed under the [MIT license](https://github.com/lquixada/cross-fetch/blob/main/LICENSE) © [Leonardo Quixadá](https://twitter.com/lquixada/)
## Author
|[](https://github.com/lquixada)|
|:---:|
|[@lquixada](http://www.github.com/lquixada)|
---
_Source: https://npm.io/package/cross-fetch · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._