Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 2.45 KB

README.md

File metadata and controls

74 lines (51 loc) · 2.45 KB
Raw

sugar-fetch

A little convenience for many fetch() use cases. Started here.

Basically a thin wrapper on the fetch().then((res) => (res.json())) pattern with the following extras:

  • Always adds the same-origin credentials to the request
  • Uses the Mime-type of the result to determine how to read the response.
  • Uses the response.ok attribute to decide if the returned Promise should fail or not.

This covers a lot of the use-cases for the fetch() method and makes the call appear as one operation instead of two. As the name suggests, mostly sugar.

Howto

Preferably, install via NPM, e.g. npm i --save sugar-fetch and pack via e.g. WebPack. Otherwise, the script contains a check that will put the API in the window object under the name __sugar_fetch__.

Import the API as an object like this:

> const sfApi = require('sugar-fetch');

ES6 features

sugar-fetch relies quite heavily on ES6 features. If you want to load it in environments without support for that (e.g. Safari), you will need to put it behind a transpiling pipeline like Babel. It can be loaded in Node.js, but at the time of writing (2016-05-09) you will need the --harmony_destructuring flag (see an example how the test suite is invoked, here).

The object sfApi has three important methods:

.get()

The .get() method takes a URL and an object describing the desired URL parameters (as encoded by URLSearchParams).

Example:

> sfApi.get('/foo/bar', {foo: 'bar'})
// Would request the URI at /foo/bar?foo=bar

.post(), sending POST data as JSON

The other method, .post(), will call fetch() using a POST request. You supply an object as parameter that will be serialized as JSON posted to the endpoint.

Example:

> sfApi.post('/post/endpoint', {foo: 'bar'})
// Would POST to `/post/endpoint` with JSON serialized object
// `{foo: 'bar'}`

.submit(), sending POST data as a form

The third method, .submit() will call fetch() using a POST request too, but the parameter object will be converted to form data (encoded using FormData).

Example:

> sfApi.submit('/post/form', {foo: 'bar'})
// Would POST to the endpoint with the FORM data {foo: 'bar'}