WunderGraph SWR Integration

This package provides a type-safe integration of SWR with WunderGraph. SWR is a React Hooks library for data fetching. 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.

Warning: Only works with WunderGraph.

Getting Started

1npm install @wundergraph/swr swr@2.0.0

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

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

Second, run wunderctl generate to generate the code.

Now you can use the hooks.

1import { createHooks } from '@wundergraph/swr';
2import { createClient, Operations } from './components/generated/client';
3
4const { useQuery, useMutation, useSubscription, useUser, useFileUpload, useAuth } = createHooks<Operations>(
5  createClient({ baseURL: 'https://your-wundernode.com', extraHeaders: {}, customFetch: undefined })
6);
7
8export const Home: React.FC<{ city: string }> = ({ city }) => {
9  const { error, data, isValidating } = useQuery({
10    operationName: 'Weather',
11    input: { forCity: city },
12    liveQuery: true,
13  });
14
15  const { data: subData, error: subError } = useSubscription({
16    enabled: true,
17    operationName: 'Weather',
18    input: {
19      forCity: 'Berlin',
20    },
21  });
22
23  const { trigger } = useMutation({
24    operationName: 'SetName',
25  });
26  trigger({ name });
27
28  const { data, error } = useUser();
29
30  const { upload, data, error } = useFileUpload();
31
32  const { login, logout } = useAuth();
33};

Options

You can use all available options from SWR with the hooks. Due to the fact that we use the operationName + variables as key, you can't use the key option as usual. In order to use conditional-fetching you can use the enabled option.

Global Configuration

You can configure the hooks globally by using the SWRConfig context.

In case the context configuration isn't working, it's likely due to multiple versions of SWR being installed. To resolve this you can import SWRConfig directly from @wundergraph/swr to make sure the same instance is used.

1import { SWRConfig, useSWRConfig } from '@wundergraph/swr';