Skip to content

Installation

The library ships as two scoped packages:

  • @effector-tanstack-query/core — the effector adapter (works without React)
  • @effector-tanstack-query/reactuseQuery / useMutation / Suspense hooks

Install whichever you need (React package depends on core automatically).

Core only (no React)

Terminal window
npm install @effector-tanstack-query/core @tanstack/query-core effector
# or
pnpm add @effector-tanstack-query/core @tanstack/query-core effector
# or
yarn add @effector-tanstack-query/core @tanstack/query-core effector

With React hooks

Terminal window
npm install \
@effector-tanstack-query/core \
@effector-tanstack-query/react \
@tanstack/query-core \
effector \
effector-react \
react react-dom

Peer dependencies

PackageRequired byMin version
effectorcore, react>= 23.0.0
@tanstack/query-corecore>= 5.0.0
effector-reactreact>= 23.0.0
reactreact^18.0.0 or ^19.0.0

TypeScript

TypeScript is optional but recommended. The library is written in TS and ships full .d.ts. select-narrowing, generic inference, and expectTypeOf tests are part of the suite.

Minimum supported TypeScript: 5.0.