A window.fetch JavaScript polyfill.
Перейти к файлу
David Graham 89ae0c26e2 Merge pull request #158 from github/travis-sudo-false
Opt into new Travis infrastructure
2015-06-07 09:13:05 -06:00
examples Add example. 2014-10-12 17:29:40 -06:00
script Fix form content type response 2015-05-04 11:41:57 -07:00
test Add constructor test. 2015-05-29 14:03:35 -06:00
.gitignore Add senv 2015-03-15 19:44:12 -07:00
.jshintrc Set esnext option 2014-12-29 12:28:44 -06:00
.senv Add senv 2015-03-15 19:44:12 -07:00
.travis.yml Opt into new Travis infrastructure 2015-06-06 15:12:21 +02:00
LICENSE It's 2015. 2015-05-19 16:44:21 -06:00
MAINTAINING.md Fix commit command. 2014-11-13 10:29:46 -07:00
Makefile Run phantomjs seperately 2015-03-15 20:59:30 -07:00
README.md remove un-needed promise allocations in example 2015-04-13 16:17:05 -05:00
bower.json Fetch 0.9.0 2015-05-29 14:31:30 -06:00
fetch.js Fix forEach parameters. 2015-05-29 14:04:16 -06:00
package.json Fetch 0.9.0 2015-05-29 14:31:30 -06:00

README.md

window.fetch polyfill

The global fetch function is an easier way to make web requests and handle responses than using an XMLHttpRequest. This polyfill is written as closely as possible to the standard Fetch specification at https://fetch.spec.whatwg.org.

Installation

Available on Bower as fetch.

$ bower install fetch

You'll also need a Promise polyfill for older browsers.

$ bower install es6-promise

This can also be installed with npm.

$ npm install whatwg-fetch --save

(For a node.js implementation, try node-fetch)

Usage

The fetch function supports any HTTP method. We'll focus on GET and POST example requests.

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('/query', {
  method: 'post',
  body: new FormData(form)
})

Post JSON

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

File upload

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

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

fetch('/avatars', {
  method: 'post',
  body: form
})

Success and error handlers

This causes fetch to behave like jQuery's $.ajax by rejecting the Promise on HTTP failure status codes like 404, 500, etc. The response Promise is resolved only on successful, 200 level, status codes.

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

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

fetch('/users')
  .then(status)
  .then(json)
  .then(function(json) {
    console.log('request succeeded with json response', json)
  }).catch(function(error) {
    console.log('request failed', error)
  })

Response URL caveat

The Response object has a URL attribute for the final responded resource. Usually this is the same as the Request url, but in the case of a redirect, its all transparent. Newer versions of XHR include a responseURL attribute that returns this value. But not every browser supports this. The compromise requires setting a special server side header to tell the browser what URL it just requested (yeah, I know browsers).

response.headers['X-Request-URL'] = request.url

If you want response.url to be reliable, you'll want to set this header. The day that you ditch this polyfill and use native fetch only, you can remove the header hack.

Browser Support

Chrome Firefox IE Opera Safari
Latest ✔ Latest ✔ 9+ ✔ Latest ✔ 6.1+ ✔