github/fetch


A window.fetch JavaScript polyfill.

http://github.github.io/fetch/

License: MIT

Language: JavaScript

Keywords: fetch, javascript, polyfill, promise


window.fetch polyfill

The fetch() function is a Promise-based mechanism for programmatically making web requests in the browser. This project is a polyfill that implements a subset of the standard Fetch specification, enough to make fetch a viable replacement for most uses of XMLHttpRequest in traditional web applications.

Table of Contents

Read this first

  • If you believe you found a bug with how fetch behaves in your browser, please don't open an issue in this repository unless you are testing in an old version of a browser that doesn't support window.fetch natively. This project is a polyfill, and since all modern browsers now implement the fetch function natively, no code from this project actually takes any effect there. See Browser support for detailed information.

  • If you have trouble making a request to another domain (a different subdomain or port number also constitutes another domain), please familiarize yourself with all the intricacies and limitations of CORS requests. Because CORS requires participation of the server by implementing specific HTTP response headers, it is often nontrivial to set up or debug. CORS is exclusively handled by the browser's internal mechanisms which this polyfill cannot influence.

  • This project doesn't work under Node.js environments. It's meant for web browsers only. You should ensure that your application doesn't try to package and run this on the server.

  • If you have an idea for a new feature of fetch, submit your feature requests to the specification's repository. We only add features and APIs that are part of the Fetch specification.

Installation

npm install whatwg-fetch --save

As an alternative to using npm, you can obtain fetch.umd.js from the Releases section. The UMD distribution is compatible with AMD and CommonJS module loaders, as well as loading directly into a page via <script> tag.

You will also need a Promise polyfill for older browsers. We recommend taylorhakes/promise-polyfill for its small size and Promises/A+ compatibility.

Usage

For a more comprehensive API reference that this polyfill supports, refer to https://github.github.io/fetch/.

Importing

Importing will automatically polyfill window.fetch and related APIs:

import 'whatwg-fetch'

window.fetch(...)

If for some reason you need to access the polyfill implementation, it is available via exports:

import {fetch as fetchPolyfill} from 'whatwg-fetch'

window.fetch(...)   // use native browser version
fetchPolyfill(...)  // use polyfill implementation

This approach can be used to, for example, use abort functionality in browsers that implement a native but outdated version of fetch that doesn't support aborting.

For use with webpack, add this package in the entry configuration option before your application entry point:

entry: ['whatwg-fetch', ...]

HTML

fetch('/users.html')
  .then(function(response) {
    return response.text()
  }).then(function(body) {
    document.body.innerHTML = body
  })

JSON

fetch('/users.json')
  .then(function(response) {
    return response.json()
  }).then(function(json) {
    console.log('parsed json', json)
  }).catch(function(ex) {
    console.log('parsing failed', ex)
  })

Response metadata

fetch('/users.json').then(function(response) {
  console.log(response.headers.get('Content-Type'))
  console.log(response.headers.get('Date'))
  console.log(response.status)
  console.log(response.statusText)
})

Post form

var form = document.querySelector('form')

fetch('/users', {
  method: 'POST',
  body: new FormData(form)
})

Post JSON

fetch('/users', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Hubot',
    login: 'hubot',
  })
})

File upload

var input = document.querySelector('input[type="file"]')

var data = new FormData()
data.append('file', input.files[0])
data.append('user', 'hubot')

fetch('/avatars', {
  method: 'POST',
  body: data
})

Caveats

  • The Promise returned from fetch() won't reject on HTTP error status even if the response is an HTTP 404 or 500. Instead, it will resolve normally, and it will only reject on network failure or if anything prevented the request from completing.

  • For maximum browser compatibility when it comes to sending & receiving cookies, always supply the credentials: 'same-origin' option instead of relying on the default. See Sending cookies.

Handling HTTP error statuses

To have fetch Promise reject on HTTP error statuses, i.e. on any non-2xx status, define a custom response handler:

function checkStatus(response) {
  if (response.status >= 200 && response.status < 300) {
    return response
  } else {
    var error = new Error(response.statusText)
    error.response = response
    throw error
  }
}

function parseJSON(response) {
  return response.json()
}

fetch('/users')
  .then(checkStatus)
  .then(parseJSON)
  .then(function(data) {
    console.log('request succeeded with JSON response', data)
  }).catch(function(error) {
    console.log('request failed', error)
  })

Sending cookies

For CORS requests, use credentials: 'include' to allow sending credentials to other domains:

fetch('https://example.com:1234/users', {
  credentials: 'include'
})

To disable sending or receiving cookies for requests to any domain, including the current one, use the "omit" value:

fetch('/users', {
  credentials: 'omit'
})

The default value for credentials is "same-origin".

The default for credentials wasn't always the same, though. The following versions of browsers implemented an older version of the fetch specification where the default was "omit":

  • Firefox 39-60
  • Chrome 42-67
  • Safari 10.1-11.1.2

If you target these browsers, it's advisable to always specify credentials: 'same-origin' explicitly with all fetch requests instead of relying on the default:

fetch('/users', {
  credentials: 'same-origin'
})

Receiving cookies

As with XMLHttpRequest, the Set-Cookie response header returned from the server is a forbidden header name and therefore can't be programmatically read with response.headers.get(). Instead, it's the browser's responsibility to handle new cookies being set (if applicable to the current URL). Unless they are HTTP-only, new cookies will be available through document.cookie.

Obtaining the Response URL

Due to limitations of XMLHttpRequest, the response.url value might not be reliable after HTTP redirects on older browsers.

The solution is to configure the server to set the response HTTP header X-Request-URL to the current URL after any redirect that might have happened. It should be safe to set it unconditionally.

# Ruby on Rails controller example
response.headers['X-Request-URL'] = request.url

This server workaround is necessary if you need reliable response.url in Firefox < 32, Chrome < 37, Safari, or IE.

Aborting requests

This polyfill supports the abortable fetch API. However, aborting a fetch requires use of two additional DOM APIs: AbortController and AbortSignal. Typically, browsers that do not support fetch will also not support AbortController or AbortSignal. Consequently, you will need to include an additional polyfill for these APIs to abort fetches:

import 'abortcontroller-polyfill/dist/abortcontroller-polyfill-only'
import {fetch} from 'whatwg-fetch'

// use native browser implementation if it supports aborting
const abortableFetch = ('signal' in new Request('')) ? window.fetch : fetch

const controller = new AbortController()

abortableFetch('/avatars', {
  signal: controller.signal
}).catch(function(ex) {
  if (ex.name === 'AbortError') {
    console.log('request aborted')
  }
})

// some time later...
controller.abort()

Browser Support

  • Chrome
  • Firefox
  • Safari 6.1+
  • Internet Explorer 10+

Note: modern browsers such as Chrome, Firefox, Microsoft Edge, and Safari contain native implementations of window.fetch, therefore the code from this polyfill doesn't have any effect on those browsers. If you believe you've encountered an error with how window.fetch is implemented in any of these browsers, you should file an issue with that browser vendor instead of this project.

Project Statistics

Sourcerank 22
Repository Size 430 KB
Stars 22,500
Forks 2,151
Watchers 484
Open issues 12
Dependencies 16
Contributors 56
Tags 28
Created
Last updated
Last pushed

Top Contributors See all

Mislav Marohnić Joshua Peek David Graham Matt Andrews João Vieira James Laurence Rowe Nikhil Marathe Bryan Smith woudini Kurt Ruppel Roney Thomas Matt King Kirill Konshin Emily Eisenberg Max Goodman Remco Haszing othree Mike McQuaid Tim Schaub

Packages Referencing this Repo

fetch
A window.fetch JavaScript polyfill.
Latest release v3.0.0 - Published - 22.5K stars
@aleclarson/whatwg-fetch
A window.fetch polyfill.
Latest release 3.0.0 - Published - 22.5K stars
@xg-wang/whatwg-fetch
Fork of whatwg-fetch to provide umd build before official release
Latest release 3.0.0 - Published - 22.5K stars
org.webjars.bower:github-com-github-fetch
WebJar for fetch
Latest release 2.0.4 - Published - 22.5K stars
whatwg-fetch-retry
A window.fetch polyfill.
Latest release 1.1.1 - Updated - 22.5K stars
rewhatwg-fetch
A re window.fetch polyfill.
Latest release 2.0.2 - Updated - 22.5K stars
whatwg-fetch
A window.fetch polyfill.
Latest release 3.0.0 - Updated - 22.5K stars
cjs-fetch
This exposes `fetch` as a CommonJS module. It's a light fork of [`whatwg-fetch`](https://www.npmj...
Latest release 0.7.0 - Published - 22.5K stars
whatwg-fetch-importable
A window.fetch polyfill and importable module.
Latest release 1.0.3 - Updated - 22.5K stars
whatwg-fetch-edu
A window.fetch polyfill.
Latest release 1.0.3 - Updated - 22.5K stars
org.webjars.bower:fetch
WebJar for fetch
Latest release 2.0.4 - Updated - 22.5K stars
@union/whatwg-fetch
A window.fetch polyfill.
Latest release 2.0.4 - Published - 22.5K stars
whatwg-fetch-strict
A window.fetch polyfill. (strict mode)
Latest release 1.0.0 - Published - 22.5K stars
whatwg-fetch-expose-xhr
A window.fetch polyfill.
Latest release 0.11.0 - Published - 22.5K stars
whatwg-fetch
A window.fetch JavaScript polyfill.
Latest release v3.0.0 - Published - 22.5K stars
cocos-fetch
A window.fetch polyfill for cocos2d-js
Latest release 1.0.0 - Published - 22.5K stars
org.webjars.bower:whatwg-fetch
WebJar for fetch
Latest release 2.0.3 - Updated - 22.5K stars

Recent Tags See all

v3.0.0 September 07, 2018
v2.0.4 March 29, 2018
v2.0.3 March 02, 2017
v2.0.2 January 19, 2017
v1.1.1 November 17, 2016
v2.0.1 November 17, 2016
v2.0.0 November 14, 2016
v1.1.0 November 14, 2016
v0.11.1 May 05, 2016
v1.0.0 April 28, 2016
v0.11.0 January 19, 2016
v0.10.1 November 02, 2015
v0.10.0 October 12, 2015
v0.9.0 May 29, 2015
v0.8.2 May 19, 2015

Interesting Forks See all

undoZen/fetch
A window.fetch JavaScript polyfill.
JavaScript - MIT - Last pushed - 35 stars - 4 forks
benestudio/fetch
A window.fetch JavaScript polyfill.
JavaScript - MIT - Last pushed - 6 stars
gsathya/cancelable-fetch
A window.fetch JavaScript polyfill.
JavaScript - MIT - Last pushed - 3 stars
philmander/fetchify
A window.fetch JavaScript polyfill.
JavaScript - MIT - Last pushed - 2 stars
webmechanicx/fetch
A window.fetch JavaScript polyfill.
JavaScript - Updated - 2 stars

Something wrong with this page? Make a suggestion

Last synced: 2019-04-20 01:51:45 UTC

Login to resync this repository