❤
npm
Sign UpSign In

fetch.io
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/fetch.io package

5.0.0 • Public • Published

NPM version Build status Test coverage License Dependency status

fetch.io

Extends the whatwg fetch - fetch spec api, makes it easier to use. Both node & browser supported.

  • install
npm install fetch.io
  • import
import Fetch from 'fetch.io'
  • for TypeScript users
npm install @types/fetch.io

APIs

  • .config() - set options

  • .set() - set http header

  • .type() - set content type

  • .send() - send body data

  • .query() - set query string

  • .append() - append form data

  • .text() - convert response body to string

  • .json(strict = true) - convert response body to object (strict JSON mode default)

Options

  • beforeRequest - Function, a pre-request hook function, returning false will cancel the request
  • afterResponse - Function, a post-response hook function
  • afterJSON - Function, add a handler for .json(), to check the response data
  • prefix - String, url prefix
  • Other whatwg-fetch options

Usage

const request = new Fetch({
  prefix: 'http://example.com/api/v1'
})
  • default options
{
  prefix: '',
  mode: 'cors',
  cache: 'no-cache',
  credentials: 'include'
}
request
  .get(path)
  .config({
    credentials: 'omit'
  })
  .query({
    type: 1
  })
  .query({
    name: 'hello'
  })
  .then(res => {
    // fetch response
  })
  .catch(err => {
    // ...
  })
  • get json body
request
  .get(path)
  .json()
  .then(body => {
    // response body
  })
  .catch(err => {
    // ...
  })
  • get text body
request
  .get(path)
  .text()
  .then(body => {
    // response body
  })
  .catch(err => {
    // ...
  })
  • send json
request
  .post(path)
  .send({
    type: 1
  })
  .send({
    name: 'hello'
  })
  .then(res => {
    // fetch response
  })
  .catch(err => {
    // ...
  })
  • send urlencoded
request
  .post(path)
  .send('type=1')
  .send('name=hello')
  .then(res => {
    // fetch response
  })
  .catch(err => {
    // ...
  })
  • send urlencoded
request
  .post(path)
  .type('form')
  // equal to:
  // .type('urlencoded')
  // equal to:
  // .set('content-type', 'application/x-www-form-urlencoded')
  .send({
    type: 1,
    name: 'hello'
  })
  .then(res => {
    // fetch response
  })
  .catch(err => {
    // ...
  })
  • set header
request
  .post(path)
  .set({
    'content-type': 'application/json'
  })
  .send({
    name: 'hello'
  })
  .then(res => {
    // fetch response
  })
  .catch(err => {
    // ...
  })
  • send form (multipart) (upload file)
request
  .post(path)
  .append('filename', 'user.png')
  .append('file': document.querySelector('input[type="file"]')files[0])
  .append({reason: 'set user avatar'})
  .then(res => {
    // fetch response
  })
  .catch(err => {
    // ...
  })

License

MIT

Readme

Keywords

Package Sidebar

Install

npm i fetch.io

Repository

github.com/haoxins/fetch.io

Homepage

github.com/haoxins/fetch.io#readme

Weekly Downloads

21

Version

5.0.0

License

MIT

Unpacked Size

20.7 kB

Total Files

5

Last publish

Collaborators

  • coderhaoxin
  • haoxins
  • newraina
Try on RunKit
Report malware