Skip to content

cooperwfloyd/fancyfetch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Dec 17, 2024
8e641f6 · Dec 17, 2024
Mar 3, 2023
Jan 3, 2024
Dec 17, 2024
Apr 6, 2023
Apr 6, 2023
Mar 5, 2023
Mar 9, 2023
Nov 1, 2023
Mar 3, 2023
Mar 3, 2023
Nov 1, 2023
Mar 3, 2023
Mar 9, 2023
Dec 17, 2024
Dec 17, 2024
Apr 6, 2023
Apr 2, 2023

Repository files navigation

💅 fancyfetch

fancyfetch is a simple, lightweight and isomorphic extension of the fetch API to allow for graceful error handling, response validation, automatic retries, and the ability to use any fetch API package.

🙂 Basic usage

Import using the default export from @cooperwfloyd/fancyfetch. fancyfetch can be used client-side in the browser or on the server just like the standard fetch API — fancyfetch will automatically locate and use Node's global fetch API or your browser's native fetch API.

import fancyfetch from '@cooperwfloyd/fancyfetch';

const data = await fancyfetch('https://www.example.com');

🥳 Fancy usage

The third argument is available for all of fancyfetch's extensions, including:

👇 The ability to use a custom fetch API instead of the global default

import fancyfetch from '@cooperwfloyd/fancyfetch';
import fetch from 'node-fetch';

const data = await fancyfetch(
  'https://www.example.com/a-large-server-side-request',
  {highWaterMark: 2048 * 2048},
  {fetch}
);

👇 The ability to gracefully auto-retry requests if they fail or if their responses don't return true in a custom validation callback

import fancyfetch from '@cooperwfloyd/fancyfetch';

const data = await fancyfetch(
  'https://www.example.com/json',
  {
    headers: {
      'Content-Type': 'application/json',
    },
  },
  {
    maxAttempts: 10,
    retryDelay: 1000,
    validateResponse: async (response) => {
      try {
        const json = await response?.json();
        return !!json?.data;
      } catch {
        return false;
      }
    },
    onRetrySuccess: () => console.log('Successful retry'),
    onRetryError: () => console.error('Failed retry'),
    onError: () => console.error('No successful attempts'),
  }
);

✏️ Reference

  • resource (required): fetch.resource
  • options: fetch.options
  • extras
    • fetch: function
      • The fetch API (ex. fetch, node-fetch, isomorphic-fetch) that requests should use (default, in order of specificity: fetch, global.fetch, window.fetch)
    • log: boolean
      • Dictates whether or not fancyfetch's console statements should be fired (default: true)
    • validateResponse: function
      • This callback function allows for checking the response to determine it's validity. It sends the response as an argument and should return a truthy or falsy value since fancyfetch will use a boolean to determine the response's validity.
    • maxAttempts: number
      • Specifies the maximum number of times that the request should be attempted (default: 1). The validateResponse callback should be used whenever maxAttempts is greater than one since fancyfetch will not know when to break out of the recursive retry loop without it.
    • retryDelay: number
      • Specifies the number of milliseconds that fancyfetch should wait before retrying a failed request.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published