use-rq-fetcher

A custom React Query fetcher hook for dynamic Axios integrations.

📦 Install

npm install use-rq-fetcher


yarn add use-rq-fetcher

🚀 Features

• Dynamic Response Types: Fully type-safe with TypeScript generics.
• Integration with Axios: Easy configuration of headers, base URLs, and params.
• React Query Powered: Leverages the full capabilities of React Query for caching, refetching, and error handling.
• Highly Configurable: Supports all options of React Query's useQuery.

📚 Peer Dependencies

you must install this packajes ! برای استفاده از این هوک ، مطمئن شوید موارد زیر در پروژه شما نصب است

1@tanstack/react-query: >=5.64.2
2react: >=19.0.0
3typescript: >=5.7.3
4axios: >=1.7.9

🛠️ Example Usage

1import React from "react";
2import { useRQFetcher } from "use-rq-fetcher";
3import axios from "axios";
4import API from "@/utils/interceptor"; // from your axios instance in interceptor
5
6interface MyResponseType {
7  name : string
8}
9
10const MyComponent = () => {
11  const { data, isLoading, error } = useRQFetcher<commonresponse<MyResponseType>, commonresponse>({
12    API,
13    url: "/endpoint",
14    queryKey: ["example-data"],
15    params: { page: "example number like 1" , limit: "example number like 10" },
16  });
17
18  if (isLoading) return <div>Loading...</div>;
19  if (error) return <div>Error occurred: {error.message}</div>;
20
21  return <div>Data: {data?.name}</div>;
22};
23
24export default MyComponent;

Inputs (Parameters)

Parameter	Type	Default	Description
API	AxiosInstance	Required	An Axios instance for making HTTP requests.
baseURL	string	your damain	Base URL for the API, used if provided.
url	string	Required	The endpoint URL for the request.
queryKey	`Array<string	number>`	Required
headers	AxiosHeaders or object	{}	Additional headers for the request.
params	object	{}	Query parameters to append to the URL.
pathParams	object	{}	Path parameters to replace placeholders in the URL.
...rest	UseQueryOptions<TData, TError>	N/A	Additional options for the useQuery hook from React Query.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

🔄 Changelog

[1.0.12] - Initial Release : اطلاعات مربوط به تغییرات ارائه شده در اخرین نسخه هوک :