Tanstack Query Integration For Solid

This guide shows how to integrate oRPC with Tanstack Query for Solid. For an introduction, please review the Basic Guide first.

Installation

npm

npm install @orpc/solid-query@latest @tanstack/solid-query@latest

yarn

yarn add @orpc/solid-query@latest @tanstack/solid-query@latest

pnpm

pnpm add @orpc/solid-query@latest @tanstack/solid-query@latest

bun

bun add @orpc/solid-query@latest @tanstack/solid-query@latest

deno

deno add npm:@orpc/solid-query@latest npm:@tanstack/solid-query@latest

Setup

Before you begin, ensure you have already configured a server-side client or a client-side client.

import { createORPCSolidQueryUtils } from '@orpc/solid-query'

export const orpc = createORPCSolidQueryUtils(client)

orpc.planet.find.
queryOptions({ input: { id: 123 } })

//

Avoiding Query/Mutation Key Conflicts

Prevent key conflicts by passing a unique base key when creating your utils:

const userORPC = createORPCSolidQueryUtils(userClient, {
  path: ['user']
})
const postORPC = createORPCSolidQueryUtils(postClient, {
  path: ['post']
})

Usage

WARNING

Unlike the React version, when creating a Solid Query Signal, the first argument must be a callback.

import { createQuery } from '@tanstack/solid-query'

const query = createQuery(
  () => orpc.planet.find.queryOptions({ input: { id: 123 } })
)