Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

useQueryClient.md

48 lines1.0 KB

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

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

  const queryClient = useQueryClient()

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