🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

react-api-utils

Package Overview
Dependencies
Maintainers
0
Versions
3
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-api-utils

A React utility library for making API calls using React Query and Axios, providing context-based configuration and custom hooks for seamless integration.

0.0.5
latest
Source
npm
Version published
Weekly downloads
3
-62.5%
Maintainers
0
Weekly downloads
 
Created
Source

React API Utils

A utility library for simplifying API requests in React applications. Built on top of React Query and Axios, it provides a seamless way to manage API calls and caching with an intuitive context-based setup.

Features

  • 🌐 Axios Integration: Customize API calls with ease.
  • React Query: Automatic caching, refetching, and stale data management.
  • 📦 Async Storage Support: Persisted caching for React Native or browser-based environments.
  • 🛠️ TypeScript Ready: Fully typed for better developer experience.

Installation

npm install react-api-utils
# or
yarn add react-api-utils

Usage

Setup Provider

Wrap your application with the ApiHelperProvider to set up the context and configuration.

import React from 'react';
import { ApiHelperProvider } from 'react-api-utils';

const App = () => (
  <ApiHelperProvider baseURL="https://api.example.com">
    <YourApp />
  </ApiHelperProvider>
);

export default App;

Using useApiHelper

Leverage the useApiHelper hook to perform API requests effortlessly.

import { useApiHelper } from 'react-api-utils';

const MyComponent = () => {
  const { data, isLoading, isError } = useApiHelper({
    url: '/endpoint',
    method: 'GET',
    queryKey: ['endpoint-data'],
  });

  if (isLoading) return <p>Loading...</p>;
  if (isError) return <p>Something went wrong!</p>;

  return <pre>{JSON.stringify(data, null, 2)}</pre>;
};

API

ApiHelperProvider

PropTypeDefaultDescription
baseURLstringundefinedBase URL for all Axios requests.
axiosConfigAxiosRequestConfig{}Custom Axios configuration.
queryClientConfigQueryClientConfig{}React Query client configuration.

useApiHelper

OptionTypeDescription
urlstringAPI endpoint to fetch data from.
method'GET' , 'POST' , 'PUT' , 'DELETE'HTTP method for the request.
queryKeyArray<string>Unique key for React Query's cache management.

Contributing

Contributions are welcome! Feel free to submit issues or pull requests.

Keywords

react

FAQs

Package last updated on 02 Jan 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts