Skip to content

Latest commit

 

History

History
88 lines (65 loc) · 3.85 KB

README.md

File metadata and controls

88 lines (65 loc) · 3.85 KB
Raw

TanStack Query Firebase

A set of TanStack Query hooks integrating with Firebase.

Installation • Documentation • License


TanStack Query Firebase provides a set of hooks for handling asynchronous tasks with Firebase in your applications.

Important

This project is currently a work in progress.

Looking for React Query Firebase? Check out the old branch.

Why use this library?

When managing Firebase’s asynchronous API calls within your application, state synchronization can become cumbersome in most applications. You will commonly find yourself handling loading states, error states, and data synchronization manually.

This library provides a hands-off approach to these problems, by leveraging the popular TanStack Query project. Out of the box, you get:

  • Automatic Caching: Avoid redundant Firebase calls with built-in caching.
  • Out-of-the-box Synchronization: TanStack Query keeps your UI in sync with the Firebase backend effortlessly.
  • Background Updates: Fetch and sync data seamlessly in the background without interrupting the user experience.
  • Error Handling & Retries: Get automatic retries on failed Firebase calls, with robust error handling baked in.
  • Dev Tools for Debugging: Leverage the React Query Devtools to gain insights into your data-fetching logic and Firebase interactions.

By combining Firebase with TanStack Query, you can make your app more resilient, performant, and scalable, all while writing less code.

Installation

This project expects you have firebase installed as a peer dependency. If you haven't done so already, install firebase:

npm i --save firebase

Next, install specific packages for your framework of choice:

React

npm i --save @tanstack/react-query @tanstack-query-firebase/react

See the Documentation for more information on how to use the library.

Status

The status of the following Firebase services and frameworks are as follows:

  • ✅ Ready for use
  • 🟠 Work in progress
  • () Not yet started
Module React Vue Solid Angular Svelte
analytics
app-check
auth 🟠
database
data-connect ✅
firestore 🟠
firestore/lite
functions
installations
messaging
performance
remote-config
vertexai

License

Built and maintained by Invertase.