Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
Neon
WorkOS
Clerk
Convex
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
Neon
WorkOS
Clerk
Convex
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
Getting Started

Installation

You can install Preact Query via NPM, or a good ol' <script> via ESM.sh.

NPM

sh
npm i @tanstack/preact-query

or

sh
pnpm add @tanstack/preact-query

or

sh
yarn add @tanstack/preact-query

or

sh
bun add @tanstack/preact-query

Wanna give it a spin before you download? Try out the simple example

CDN

If you're not using a module bundler or package manager, you can also use this library via an ESM-compatible CDN such as ESM.sh. Simply add a <script type="module"> tag to the bottom of your HTML file:

html
<script type="module">
  import { render } from 'https://esm.sh/preact@10.23.1'
  import { QueryClient } from 'https://esm.sh/@tanstack/preact-query'
</script>

Requirements

Preact Query is optimized for modern browsers. It is compatible with the following browsers config

Chrome >= 91
Firefox >= 90
Edge >= 91
Safari >= 15
iOS >= 15
Opera >= 77

Depending on your environment, you might need to add polyfills. If you want to support older browsers, you need to transpile the library from node_modules yourselves.

Recommendations

It is recommended to also use our ESLint Plugin Query to help you catch bugs and inconsistencies while you code. You can install it via:

sh
npm i -D @tanstack/eslint-plugin-query

or

sh
pnpm add -D @tanstack/eslint-plugin-query

or

sh
yarn add -D @tanstack/eslint-plugin-query

or

sh
bun add -D @tanstack/eslint-plugin-query