TanStack Query recipes

Feed shared updates into your existing query cache.

Framework Connection

GraphQL over WebSocket · React Router

Before you start

Start with an existing React Router app. Keep its renderer, routes and plugins. These files add one live view; Spinetab does not create your API.

Your schema exposes Subscription.queue: Queue! with Queue.open: Int!. Each event contains the complete queue value. Serve the graphql-transport-ws protocol at /graphql. Queries and mutations, if used, go to /graphql. This is a GraphQL endpoint, not a plain SSE or WebSocket feed.

The examples use same-origin URLs and declare anonymous: true: no token is supplied, although cookies still flow. For a separate API origin, use its URL and configure CORS or your application's proxy. For private data, add credentials and user scopes; never put a secret in these files.

1. Install

pnpm add spinetab graphql@^17.0.2 graphql-ws@^6.3.0 @tanstack/query-core@^5.104.0 @tanstack/react-query@^5.104.0

Keep your framework's existing dependencies. See compatible versions if upgrading an older app.

2. Configure your app

Merge this addition into your configuration; preserve existing plugins and options. Restart the dev server afterwards. The plugin bundles the worker and discovers the adapters imported below.

import { reactRouter } from "@react-router/dev/vite";
import { spinetab } from "spinetab/vite";
import { defineConfig } from "vite";

export default defineConfig({
  plugins: [reactRouter(), spinetab()],
  optimizeDeps: { entries: ["app/**/*.{ts,tsx}"] },
});

3. Connect and render

Save these files together in app/recipe/.

The provider owns a fresh QueryClient. If your app already has a provider, render Queue beneath it instead of creating another one. The query uses skipToken to read live cache updates without fetching a competing snapshot. The bridge uses that same client's ["queue"] key.

reconcile: "latest" fits this full-state contract: the next complete event restores the displayed value after a gap. Use a refresh/merge policy for deltas or partial GraphQL results. Reconnecting alone does not reconstruct missed state.

import { createSpinetab } from "spinetab";

export const spinetab = createSpinetab({ anonymous: true });

export type Queue = { open: number };
export type QueueView = { open?: number; problem?: string };

import { parse } from "graphql";
import {
  type GraphqlDocument,
  type GraphqlResult,
  graphqlWs,
} from "spinetab/graphql-ws";
import type { Queue, QueueView } from "./queue-types";

const document: GraphqlDocument<
  { queue: Queue },
  Record<string, never>
> = parse("subscription Queue { queue { open } }");

export const queueSource = graphqlWs("/graphql").subscription({
  query: document,
});

export function selectQueue(
  result: GraphqlResult<{ queue: Queue }>,
): QueueView {
  return {
    open: result.data?.queue?.open,
    problem:
      result.errors?.map((error) => error.message).join("; ") ||
      (result.data?.queue ? undefined : "The server returned no queue."),
  };
}

import type { QueryClient } from "@tanstack/query-core";
import { bindQuery } from "spinetab/tanstack-query";
import { spinetab } from "./live";
import { queueSource, selectQueue } from "./source";

export function startQueue(
  queryClient: QueryClient,
  onError: (message: string) => void,
) {
  return bindQuery(spinetab, queueSource, {
    queryClient,
    queryKey: ["queue"],
    map: selectQueue,
    reconcile: "latest",
    onError: (error) => onError(error.message),
    onEvent: () => onError(""),
  });
}

import { skipToken, useQuery, useQueryClient } from "@tanstack/react-query";
import { useEffect, useState } from "react";
import { startQueue } from "./feed";
import type { QueueView } from "./queue-types";

export default function Queue() {
  const client = useQueryClient();
  const { data } = useQuery<QueueView>({
    queryKey: ["queue"],
    queryFn: skipToken,
  });
  const [error, setError] = useState("");
  useEffect(() => {
    const binding = startQueue(client, setError);
    return () => binding.unsubscribe();
  }, [client]);
  if (error || data?.problem)
    return <p role="alert">{error || data?.problem}</p>;
  if (data?.open === undefined) return <p role="status">Loading queue…</p>;
  return (
    <p>
      <output>{data.open}</output> open
    </p>
  );
}

import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
import { useState } from "react";
import Queue from "./Queue";

export default function Recipe() {
  const [client] = useState(() => new QueryClient());
  return (
    <QueryClientProvider client={client}>
      <Queue />
    </QueryClientProvider>
  );
}

4. Mount the view

import Recipe from "../recipe/Recipe";
export default function QueuePage() {
  return (
    <main>
      <Recipe />
    </main>
  );
}

import { type RouteConfig, route } from "@react-router/dev/routes";

export default [route("queue", "routes/queue.tsx")] satisfies RouteConfig;

Keep your existing routes and root Outlet. The dependency-scan entries include route imports on a cold first visit. Declarative/Data Mode apps use the Vite recipe instead.

Check the result

Open /queue in two tabs of the same browser profile. Both should show advancing queue values. Matching subscriptions share upstream work when SharedWorker is available; fallback runs independently in each tab. Remove one view and the other should keep updating. Removing the last view releases its subscription; connection closure can follow the adapter's idle delay.

API options and advanced recovery · Authentication