react-fetch-it v1.0.0-rc.2

react-fetch-it

React hooks for interacting with the fetch API. Includes the ability to add middleware to intercept, modify, cancel, cache, or analyze fetch calls.

Installation

$ npm i -S react-fetch-it

Basic Usage

Basic Usage (Immediate Execution)

import { useFetchGet } from 'react-fetch-it';

export function MyComponent() {
  const { loading, error, value: movie } = useFetchGet<Movie>('/api/movies/42'); // NOTE: Only submits request if URL changes.
  
  return (
    loading ? <div>Loading...</div>
      : error ? <div>Error: {error.message}</div>
      : <div>{movie.title} ({movie.year}) by {movie.director}</div>
  );
}

type Movie = {
  id: number;
  title: string;
  year: number;
  director: string;
};

Basic Usage (On-Demand Execution)

import { useState } from 'react';
import { useFetchGetFn } from 'react-fetch-it';

export function MyComponent() {
  const [ { loading, error, value: movie }, fetchMovie ] = useFetchGetFn<Movie>(`/api/movies/42`);

  return (
    loading ? <div>Loading...</div>
      : error ? <div>Error: {error.message}</div>
      : movie ? <div>{movie.title} ({movie.year}) by {movie.director}</div>
      : <button onClick={fetchMovie}>Fetch it, yo!</button>
  );
}

Add "Standard" Options for All Requests (Without Provider)

// main.ts

import { addFetchItMiddleware } from 'react-fetch-it';
import standardOptionsMiddleware from 'react-fetch-it/middleware/standard-options';

addFetchItMiddleware(
 standardOptionsMiddleware
);

// ...

Advanced Usage

Adding Static Middleware

// main.ts

import { addFetchItMiddleware } from 'react-fetch-it';

addFetchItMiddleware(
  // Add middleware here...
);

// ...

Adding Dynamic Middleware

import FetchItMiddlewareProvider from 'react-fetch-it/MiddlewareProvider';

export function App() {
  // ...
  
  return (
    <FetchItMiddlewareProvider middleware={[
      // Add middleware here...
    ]}>
      {/* ... */}
    </FetchItMiddlewareProvider>
  );
}

Aborting a Request

// main.ts

import { addFetchItMiddleware, FetchItMiddlewareOptions } from 'react-fetch-it';

addFetchItMiddleware(
  // ...

  (options: FetchItMiddlewareOptions) => {
    // do some logic...
    return false; // returning `false` from a middleware will abort the request.
  }
)

...or...

import FetchItMiddlewareProvider from 'react-fetch-it/MiddlewareProvider';
import type { FetchItMiddleware } from 'react-fetch-it';

export function App() {
  const abortFetchItMiddleware: FetchItMiddleware = (options: FetchItMiddlewareOptions) => {
    // do some logic...
    return false; // returning `false` from a middleware will abort the request. 
  };

  return (
    <FetchItMiddlewareProvider middleware={[
      abortFetchItMiddleware
      // ...
    ]}>
      {/* ... */}
    </FetchItMiddlewareProvider>
  );
}

Hooks

• useFetch
• useFetchFn
• useFetchResp
• useFetchRespFn
• DELETE
  • useFetchDel
  • useFetchDelFn
  • useFetchDelResp
  • useFetchDelRespFn
• GET
  • useFetchGet
  • useFetchGetFn
  • useFetchGetResp
  • useFetchGetRespFn
• HEAD
  • useFetchHead
  • useFetchHeadFn
• POST
  • useFetchPost
  • useFetchPostFn
  • useFetchPostResp
  • useFetchPostRespFn
• PUT
  • useFetchPut
  • useFetchPutFn
  • useFetchPutResp
  • useFetchPutRespFn

Middleware

You are able to provide middleware to intercept, modify, cancel, or analyze fetch calls. A few middleware are provided by this package, but you can also create your own and doing so is quite simple.

Provided Middleware

• defaultOptionsMiddleware
• simpleCacheMiddleware
• standardOptionsMiddleware

Creating Your Own Middleware

TODO

Fetch Wrappers

These are provided in case you need to make a request but do not wish to use a hook to do so. This allows all middleware and other options to still be used even when not using a hook.

• doFetch
• fetchDel
• fetchGet
• fetchHead
• fetchPost
• fetchPut

License

ISC License (ISC)

Copyright (c) 2024, Brandon D. Sara (https://bsara.dev/)

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.