Clients

React Query client

This package provides a type-safe integration of React Query with WunderGraph. React Query is a data fetching library for React. With just one hook, you can significantly simplify the data fetching logic in your project. And it also covered in all aspects of speed, correctness, and stability to help you build better experiences.

Installation

1
npm install @wundergraph/react-query @tanstack/react-query

Configuration

Before you can use the hooks, you need to modify your code generation to include the base typescript client.

1
2
3
4
5
6
7
8
9
10
11
// wundergraph.config.ts
configureWunderGraphApplication({
  // ... omitted for brevity
  codeGenerators: [
    {
      templates: [templates.typescript.client],
      // the location where you want to generate the client
      path: '../src/components/generated',
    },
  ],
});

Now you can configure the hooks. Create a new file, for example lib/wundergraph.ts and add the following code:

1
2
3
4
5
6
7
import { createHooks } from '@wundergraph/react-query';
import { createClient, Operations } from './components/generated/client';


const client = createClient(); // Typesafe WunderGraph client


export const { useQuery, useMutation, useSubscription, useUser, useFileUpload, useAuth, queryKey } =
  createHooks<Operations>(client);

In your App.tsx add QueryClientProvider:

1
2
3
4
5
6
7
8
9
10
11
import { QueryClient, QueryClientProvider } from '@tanstack/react-query';


const queryClient = new QueryClient();


export default App() {
  return (
    <QueryClientProvider client={queryClient}>
      <div>...</div>
    </QueryClientProvider>
  );
}

Usage

Now you can use the hooks in your components:

useQuery

1
2
3
4
const { data, error, isLoading } = useQuery({
  operationName: 'Weather',
  input: { forCity: city },
});

useQuery (Live query)

1
2
3
4
5
const { data, error, isLoading, isSubscribed } = useQuery({
  operationName: 'Weather',
  input: { forCity: city },
  liveQuery: true,
});

useSubscription

1
2
3
4
5
6
const { data, error, isLoading, isSubscribed } = useSubscription({
  operationName: 'Weather',
  input: {
    forCity: 'Berlin',
  },
});

useMutation

1
2
3
4
5
6
7
const { data, mutate, mutateAsync } = useMutation({
  operationName: 'SetName',
});


mutate({ name: 'WunderGraph' });


await mutateAsync({ name: 'WunderGraph' });

useFileUpload

1
2
3
4
5
6
const { upload, data: fileKeys, error } = useFileUpload();


upload({
  provider: 'minio',
  files: new FileList(),
});

useAuth

1
2
3
4
5
const { login, logout } = useAuth();


login('github');


logout({ logoutOpenidConnectProvider: true });

useUser

1
const { data: user, error } = useUser();

queryKey

You can use the queryKey helper function to create a unique key for the query in a typesafe way. This is useful if you want to invalidate the query after mutating.

1
2
3
4
5
6
7
8
9
10
const queryClient = useQueryClient();


const { mutate, mutateAsync } = useMutation({
  operationName: 'SetName',
  onSuccess() {
    queryClient.invalidateQueries(queryKey({ operationName: 'Profile' }));
  },
});


mutate({ name: 'WunderGraph' });

Options

You can use all available options from React Query with the hooks.

Previous
React Relay
Next
Solid Query

Was this article helpful to you?
Provide feedback

Edit this page