概述

@tanstack/svelte-query 包提供了通过 Svelte 使用 TanStack Query 的一等 API。

示例

在项目根目录附近包含 QueryClientProvider

svelte
<script lang="ts">
  import { QueryClient, QueryClientProvider } from '@tanstack/svelte-query'
  import Example from './lib/Example.svelte'

  const queryClient = new QueryClient()
</script>

<QueryClientProvider client={queryClient}>
  <Example />
</QueryClientProvider>
<script lang="ts">
  import { QueryClient, QueryClientProvider } from '@tanstack/svelte-query'
  import Example from './lib/Example.svelte'

  const queryClient = new QueryClient()
</script>

<QueryClientProvider client={queryClient}>
  <Example />
</QueryClientProvider>

然后从任何组件调用任何函数(例如 createQuery)

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

  const query = createQuery({
    queryKey: ['todos'],
    queryFn: () => fetchTodos(),
  })
</script>

<div>
  {#if $query.isLoading}
    <p>Loading...</p>
  {:else if $query.isError}
    <p>Error: {$query.error.message}</p>
  {:else if $query.isSuccess}
    {#each $query.data as todo}
      <p>{todo.title}</p>
    {/each}
  {/if}
</div>
<script lang="ts">
  import { createQuery } from '@tanstack/svelte-query'

  const query = createQuery({
    queryKey: ['todos'],
    queryFn: () => fetchTodos(),
  })
</script>

<div>
  {#if $query.isLoading}
    <p>Loading...</p>
  {:else if $query.isError}
    <p>Error: {$query.error.message}</p>
  {:else if $query.isSuccess}
    {#each $query.data as todo}
      <p>{todo.title}</p>
    {/each}
  {/if}
</div>

SvelteKit

如果您正在使用 SvelteKit,请查看 SSR & SvelteKit

可用函数

Svelte Query 提供了有用的函数和组件,可以使 Svelte 应用中的服务器状态管理更加轻松。

  • createQuery
  • createQueries
  • createInfiniteQuery
  • createMutation
  • useQueryClient
  • useIsFetching
  • useIsMutating
  • useHydrate
  • <QueryClientProvider>
  • <HydrationBoundary>

Svelte Query & React Query 的重要区别

Svelte Query 提供了与 React Query 类似的 API,但有一些关键区别需要注意。

  • Svelte Query 中的许多函数会返回一个 Svelte store。要响应式地访问这些 store 中的值,您需要在 store 前面加上 $ 前缀。您可以在 这里 了解更多关于 Svelte stores 的信息。
  • 如果您的查询或突变依赖于变量,则必须为选项使用 store。您可以在 这里 阅读更多关于此内容。