Reactreasure 🎣

Getting Started

Coming soon...

reactreasure API Rules

Hook names should be prefixed with use

✅

useCounter

⛔️

counter

Hook arguments and return value MUST be either a single value or an object

✅

function useMyState(initialState) {
  const [state, setState] = useState(initialState);
  return { state, setState };
}

⛔️

function useMyState(initialState) {
  const [state, setState] = useState(initialState);
  return [state, setState];
}

🧙‍♂️ Being strict and opinionated about our hooks argument and return value creates a predictable API. This also makes typing and testing easier.

Documentation

useFetch

Description Fetches data from a specified URL and manages loading and error states.

Example

const { data, loading, error, abort } = useFetch(
  'https://api.example.com/data'
);

Parameters

url: string: The URL to fetch data from. options: object (optional): Configuration options for the fetch request (e.g., method, headers).

Returns:

{
  data: T | null; // The fetched data or null if not yet available
  error: string | null; // Error message if the fetch fails, otherwise null
  loading: boolean; // A boolean indicating if the fetch is in progress
  abort: () => void; // A function to cancel the fetch request
}