json-fetch
    TypeScript icon, indicating that this package has built-in type declarations

    9.0.7 • Public • Published

    JSON Fetch

    codecov badge

    A wrapper around ES6 fetch to simplify interacting with JSON APIs.

    • automatically JSON stringify request body
    • set JSON request headers
    • resolve with json for any response with the Content-Type: application/json header
    • include request credentials by default
    • configurable retry option for requests

    build status MIT license

    Usage

    yarn add json-fetch
    # or...
    npm install json-fetch
    import jsonFetch from 'json-fetch';
    
    jsonFetch('http://www.test.com/products/1234', {
      body: {name: 'apple'}, // content to be JSON stringified
      credentials: 'omit', // "include" by default
      expectedStatuses: [201], // rejects "FetchUnexpectedStatusError" on unexpected status (optional)
      // supports all normal json-fetch options:
      method: 'POST',
    })
      .then((response) => {
        // handle response with expected status:
        console.log(response.body); // json response here
        console.log(response.status);
        console.log(response.statusText);
        console.log(response.headers);
      })
      .catch((err) => {
        // handle response with unexpected status:
        console.log(err.name);
        console.log(err.message);
        console.log(err.response.status);
        console.log(err.response.statusText);
        console.log(err.response.body);
        console.log(err.response.text);
        console.log(err.response.headers);
      });

    Retry Behavior

    By default, jsonFetch doesn't retry requests. However, you may opt in to jsonFetch's very flexible retry behavior, provided by the excellent promise-retry library. Here's a quick example:

    import jsonFetch, {retriers} from 'json-fetch'
    
    jsonFetch('http://www.test.com/products/1234', {
      method: 'POST',
      body: {name: 'apple'},
      shouldRetry: retriers.isNetworkError // after every request, retry if a network error is thrown
      retry: {
        // Retry 5 times, in addition to the original request
        retries: 5,
      }
    }).then(response => {
      // handle responses
    });

    Any option that promise-retry accepts will be passed through from options.retry. See the promise-retry documentation for all options.

    Custom Retry Logic

    We've provided two default "retrier" functions that decide to retry 503/504 status code responses and network errors (jsonFetch.retriers.is5xx and jsonFetch.retriers.isNetworkError respectively). You can easily provide your own custom retrier function to options.shouldRetry.

    The contract for a retrier function is:

    shouldRetry([Error || FetchResponse]) returns bool

    You can use any attribute of the FetchResponse or Error to determine whether to retry or not. Your function must handle both errors (such as network errors) and FetchResponse objects without blowing up. We recommend stateless, side-effect free functions. You do not need to worry about the maximum number of retries -- promise-retry will stop retrying after the maximum you specify. See the tests and src/retriers.js file for examples.

    Contributing

    Please follow our Code of Conduct when contributing to this project.

    yarn install
    yarn test
    

    Deploying a new version

    This module is automatically deployed when a version tag bump is detected by Travis. Remember to update the changelog!

    yarn version
    

    License

    MIT

    Module scaffold generated by generator-goodeggs-npm.

    Install

    npm i json-fetch

    DownloadsWeekly Downloads

    74

    Version

    9.0.7

    License

    MIT

    Unpacked Size

    61.3 kB

    Total Files

    15

    Last publish

    Collaborators

    • goodeggs-admin
    • randypuro
    • sylspren
    • dannynelson
    • demands
    • jhob
    • colincurtin