use-async-fetch
v1.3.1
Published
A custom React hook for fetching data asynchronously
Downloads
6
Readme
use-async-fetch
A custom React hook for fetching data asynchronously.
Installation
You can install the package using npm:
npm install use-async-fetch
Or using yarn:
yarn add use-async-fetch
Usage
import React from "react";
import useAsyncFetch from "use-async-fetch";
const DataFetchingComponent = () => {
const [data, isFetching, error] = useAsyncFetch(
"https://api.example.com/data"
);
if (isFetching) return <p>Loading...</p>;
if (error) return <p>Error: {error.message}</p>;
return (
<div>
<pre>{JSON.stringify(data, null, 2)}</pre>
</div>
);
};
export default DataFetchingComponent;
API
const [data, isFetching, error] = useAsyncFetch(url, options, dependencies);
Parameters
url (string): The URL to fetch data from. This parameter is required.
options (object, optional): An optional object containing settings that you want to apply to the fetch request. These options follow the same format as the native Fetch API.
dependencies (array, optional): An optional array of dependencies. The hook will re-fetch data whenever any value in this array changes. Defaults to an empty array.
Features
Caching: The hook caches fetched data based on the URL. If the same URL is requested again, it returns the cached data instead of fetching it again, reducing unnecessary network requests and improving performance.
Customizable Fetch Options: You can pass custom options to the fetch request, such as headers, methods, and body.
Dependencies: The hook can re-fetch data whenever any of the specified dependencies change, providing flexibility for dynamic data fetching.
Contributing
Contributions are welcome! Please open an issue or submit a pull request for any bugs or feature requests.