snapshot of https://github.com/TanStack/query.git (main, 2026-09-16; blobs > 131072B omitted)

docs/framework/svelte/reference/functions/infiniteQueryOptions.md

@@ -0,0 +1,178 @@
+---
+id: infiniteQueryOptions
+title: infiniteQueryOptions
+---
+
+## Call Signature
+
+```ts
+function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData, unknown>, TError>;
+```
+
+Defined in: [packages/svelte-query/src/infiniteQueryOptions.ts:92](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/infiniteQueryOptions.ts#L92)
+
+You can generally pass everything to `infiniteQueryOptions` that you can also pass to `createInfiniteQuery`.
+These options can be shared across `createInfiniteQuery` calls and imperative APIs such as
+`queryClient.infiniteQuery`. `options.queryKey` is required and is the query key to generate options for.
+
+This overload is selected when `initialData` is set.
+
+### Type Parameters
+
+#### TQueryFnData
+
+`TQueryFnData`
+
+#### TError
+
+`TError` = `Error`
+
+#### TData
+
+`TData` = [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `unknown`\>
+
+#### TQueryKey
+
+`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
+
+#### TPageParam
+
+`TPageParam` = `unknown`
+
+### Parameters
+
+#### options
+
+[`DefinedInitialDataInfiniteOptions`](../type-aliases/DefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
+
+The [DefinedInitialDataInfiniteOptions](../type-aliases/DefinedInitialDataInfiniteOptions.md) to use — everything you can pass to
+`createInfiniteQuery`, with `initialData` set.
+
+### Returns
+
+[`CreateInfiniteQueryOptions`](../type-aliases/CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `unknown`\>, `TError`\>
+
+The same options object, typed so that `queryKey` carries the inferred data type.
+
+### See
+
+[createInfiniteQuery](createInfiniteQuery.md) to run an infinite query with these options.
+
+### Example
+
+`initialData` skips the loading state on first render — even if a refetch fails, the list stays
+visible alongside the error:
+```svelte
+<script lang="ts">
+  import { infiniteQueryOptions, createInfiniteQuery } from '@tanstack/svelte-query'
+
+  const projectsOptions = infiniteQueryOptions({
+    queryKey: ['projects'],
+    queryFn: ({ pageParam }) => fetchProjects(pageParam),
+    initialPageParam: 0,
+    getNextPageParam: (lastPage) => lastPage.nextId,
+    initialData: { pages: [], pageParams: [] },
+  })
+
+  const query = createInfiniteQuery(() => projectsOptions)
+</script>
+
+{#if query.isError}
+  <span>Error: {query.error.message}</span>
+{/if}
+<ul>
+  {#each query.data.pages as page}
+    {#each page.projects as project (project.id)}
+      <li>{project.name}</li>
+    {/each}
+  {/each}
+</ul>
+```
+
+## Call Signature
+
+```ts
+function infiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options): CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> & object & QueryKeyWithDataTag<TQueryKey, InfiniteData<TQueryFnData, unknown>, TError>;
+```
+
+Defined in: [packages/svelte-query/src/infiniteQueryOptions.ts:159](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/infiniteQueryOptions.ts#L159)
+
+You can generally pass everything to `infiniteQueryOptions` that you can also pass to `createInfiniteQuery`.
+These options can be shared across `createInfiniteQuery` calls and imperative APIs such as
+`queryClient.infiniteQuery`. `options.queryKey` is required and is the query key to generate options for.
+
+### Type Parameters
+
+#### TQueryFnData
+
+`TQueryFnData`
+
+#### TError
+
+`TError` = `Error`
+
+#### TData
+
+`TData` = [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `unknown`\>
+
+#### TQueryKey
+
+`TQueryKey` *extends* readonly `unknown`[] = readonly `unknown`[]
+
+#### TPageParam
+
+`TPageParam` = `unknown`
+
+### Parameters
+
+#### options
+
+[`UndefinedInitialDataInfiniteOptions`](../type-aliases/UndefinedInitialDataInfiniteOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
+
+The [UndefinedInitialDataInfiniteOptions](../type-aliases/UndefinedInitialDataInfiniteOptions.md) to use — everything you can pass to
+`createInfiniteQuery`.
+
+### Returns
+
+[`CreateInfiniteQueryOptions`](../type-aliases/CreateInfiniteQueryOptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` & [`QueryKeyWithDataTag`](../type-aliases/QueryKeyWithDataTag.md)\<`TQueryKey`, [`InfiniteData`](../interfaces/InfiniteData.md)\<`TQueryFnData`, `unknown`\>, `TError`\>
+
+The same options object, typed so that `queryKey` carries the inferred data type.
+
+### See
+
+[createInfiniteQuery](createInfiniteQuery.md) to run an infinite query with these options.
+
+### Example
+
+A parameterized factory, so the same options object can be reused per `postId`:
+```svelte
+<script lang="ts">
+  import { infiniteQueryOptions, createInfiniteQuery } from '@tanstack/svelte-query'
+
+  let { postId }: { postId: string } = $props()
+
+  const commentsOptions = (postId: string) =>
+    infiniteQueryOptions({
+      queryKey: ['post', postId, 'comments'],
+      queryFn: ({ pageParam }) => fetchComments(postId, pageParam),
+      initialPageParam: 0,
+      getNextPageParam: (lastPage) => lastPage.nextId,
+    })
+
+  const query = createInfiniteQuery(() => commentsOptions(postId))
+</script>
+
+{#if query.isPending}
+  Loading...
+{:else if query.isError}
+  <span>Error: {query.error.message}</span>
+{:else}
+  <ul>
+    {#each query.data.pages as page}
+      {#each page.comments as comment (comment.id)}
+        <li>{comment.text}</li>
+      {/each}
+    {/each}
+  </ul>
+{/if}
+```