@bitmetro/create-query v0.0.7

create-query

A library for the excellent zustand state management library for React to simplify the fetching of data.

Installation

For npm:

npm i @bitmetro/create-query

For yarn:

yarn add @bitmetro/create-query

Usage

Create a fetch hook by passing your fetch function into createQuery:

import { createQuery } from '@bitmetro/create-query';

const getCustomer = async (id: string): Promise<Customer> => {
  const res = await fetch('...');
  return await res.json();
};

export const useFetchCustomer = createQuery(getCustomer);

Get the request function, fetch status and return value:

const MyComponent = ({ customerId }) => {
  const {
    request,  // (id: string) => Promise<Customer>
    status,   // 'fetching' | 'success' | 'error' | undefined
    value,    // Customer | null
    error,    // any | undefined
    clear,    // () => void
  } = useFetchCustomer();

  useEffect(() => {
    // Fetch a new customer when the ID changes
    request(customerId);

    // Or clear the state when the customer ID changes
    clear();
  }, [customerId]);

  return (
    <div>
      {status === 'success' && (
        <p>Hello {customer?.name}</p>
      )}
    </div>
  )
}

The types of request and value are inferred from the function you pass in.

You can also rename the returned values from the hook:

const [getCustomer, customer] = useFetchCustomer(s => [s.request, s.value]);