Skip to content
effect-api-query
Menu
v0.0.0
Start Here
InstallationRPC Quick StartHTTP Quick StartExecutable ExamplesFeature SupportCompatibility and Stability
Guides
React QueryHTTP Queries and MutationsTanStack StartCache ManagementCancellationHandle FailuresCustom Key EncodersConditional Queries
Concepts
RPC Utility TreeHTTP Utility TreeQueries and MutationsClient LifecycleSemantic KeysData Normalization
Reference
RPC FactoryHTTP FactoryRPC BuildersErrorsPublic ExportsCompatibility and Limits

Installation

Install effect-api-query and its peer dependencies.

Install the package and TanStack Query Core:

Terminal window
pnpm add effect-api-query @tanstack/query-core

With pnpm’s default peer installation enabled, this also installs the exact Effect release required by the package. If your application already pins Effect or disables automatic peer installation, install the Effect version from the package’s peerDependencies and resolve any peer mismatch before continuing. The package manifest and workspace catalog are the source for supported and tested versions.

React applications also need @tanstack/react-query, matching their Query Core version:

Terminal window
pnpm add @tanstack/react-query

Use strict TypeScript checking, ESM, and an ES2022-capable application. See the compatibility reference for the tested compiler and framework integrations.

Continue with the RPC quick start or HTTP quick start.