This package provides a type-safe integration of @tanstack/svelte-query with WunderGraph. Svelte Query is a data fetching library for Svelte apps. With simple utilities, 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.
npm install @wundergraph/svelte-query @tanstack/svelte-query
Before you can use the utilities, you need to modify your code generation to include the base typescript client.
configureWunderGraphApplication ( {
codeGenerators : [
{
templates : [ templates . typescript . client ] ,
path : '../src/components/generated' ,
} ,
] ,
} ) ;
Second, run wunderctl generate
Now you can use the utility functions.
import { createSvelteClient } from '@wundergraph/svelte-query' ;
import { createClient } from '../generated/client' ;
import type { Operations } from '../generated/client' ;
const client = createClient ( ) ;
export const { createQuery , createFileUpload , createMutation , createSubscription , getAuth , getUser , queryKey } =
createSvelteClient < Operations > ( client ) ;
Now, in your svelte layout setup Svelte Query Provider such that it is always wrapping above the rest of the app.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<script>
import Header from './Header.svelte';
import { browser } from '$app/environment';
import './styles.css';
import { QueryClient, QueryClientProvider } from '@tanstack/svelte-query';
const queryClient = new QueryClient({
defaultOptions: {
queries: {
enabled: browser,
},
},
});
</script>
<div class="app">
<QueryClientProvider client={queryClient}>
<slot />
</QueryClientProvider>
</div>
Now you can use svelte-query to call your wundergraph operations!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
<script lang="ts">
import { createQuery } from '../lib/wundergraph';
const query = createQuery({
operationName: 'Starwars',
});
</script>
<div class="counter">
<h1>Simple Query</h1>
<div>
{#if $query.isLoading}
Loading...
{/if}
{#if $query.error}
An error has occurred:
{$query.error.message}
{/if}
{#if $query.isSuccess}
<div>
<pre>{JSON.stringify($query.data.starwars_allPeople)}</pre>
</div>
{/if}
</div>
</div>
If you are working with SvelteKit, this package provides prefetchQuery utility to help with SSR
export const load : PageLoad = async ( { parent } ) => {
const { queryClient } = await parent ( ) ;
await prefetchQuery (
{
operationName : 'Dragons' ,
} ,
queryClient
) ;
} ;
This implementation is based on TanStack Svelte Query's prefetchQuery approach
You can use all available options from Svelte Query with the generated functions. 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.
You can configure the utilities globally by using the Svelte Query's QueryClient config.
