site/node_modules/fetch-ponyfill/README.md

35 lines
1.1 KiB
Markdown
Raw Permalink Normal View History

2024-10-14 06:09:33 +00:00
# Fetch Ponyfill
> WHATWG `fetch` [ponyfill](https://ponyfill.com)
This module wraps the [github/fetch](https://github.com/github/fetch) polyfill in a CommonJS module
for browserification, and avoids appending anything to the window, instead returning a setup
function when `fetch-ponyfill` is required. Inspired by
[object-assign](https://github.com/sindresorhus/object-assign).
When used in Node, delegates to `node-fetch` instead.
## Usage
### Browserify
```javascript
const {fetch, Request, Response, Headers} = require('fetch-ponyfill')(options);
```
### Webpack
```javascript
import fetchPonyfill from 'fetch-ponyfill';
const {fetch, Request, Response, Headers} = fetchPonyfill(options);
```
### Options
Where `options` is an object with the following optional properties:
| option | description |
| ------ | ----------- |
| `Promise` | An A+ Promise implementation. Defaults to `window.Promise` in the browser, and `global.Promise` in Node. |
| `XMLHttpRequest` | The XMLHttpRequest constructor. This is useful to feed in when working with Firefox OS. Defaults to `window.XMLHttpRequest`. Has no effect in Node. |