useQueryClient

function useQueryClient(queryClient?: QueryClient): QueryClient;

function useQueryClient(queryClient?: QueryClient): QueryClient;

Defined in: packages/svelte-query/src/useQueryClient.ts:24

The useQueryClient function returns the current QueryClient instance.

Parameters

queryClient?

QueryClient

Use this to use a custom QueryClient. Otherwise, the one from the nearest context will be used.

Returns

QueryClient

The current QueryClient instance.

Throws

If no queryClient argument is passed and no QueryClientProvider is found in the component tree.

Example

svelte

<script lang="ts">
  import { useQueryClient } from '@tanstack/svelte-query'

  const queryClient = useQueryClient()

  function refreshPosts() {
    queryClient.invalidateQueries({ queryKey: ['posts'] })
  }
</script>

<script lang="ts">
  import { useQueryClient } from '@tanstack/svelte-query'

  const queryClient = useQueryClient()

  function refreshPosts() {
    queryClient.invalidateQueries({ queryKey: ['posts'] })
  }
</script>

Parameters

queryClient?

Returns

Throws

Example

Want to Skip the Docs?