From 38691e95ccadd783fda8d1f263a35dad24961fec Mon Sep 17 00:00:00 2001 From: Wonsuk Choi Date: Tue, 22 Sep 2026 15:34:58 +0900 Subject: [PATCH] docs(svelte-query): correct 'initialData'/'select' JSDoc inaccuracy --- docs/framework/svelte/reference/functions/createQuery.md | 7 ++++--- docs/framework/svelte/reference/functions/queryOptions.md | 7 ++++--- packages/svelte-query/src/createQuery.ts | 3 ++- packages/svelte-query/src/queryOptions.ts | 3 ++- 4 files changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/framework/svelte/reference/functions/createQuery.md b/docs/framework/svelte/reference/functions/createQuery.md index c55ccef74c2..52037bed902 100644 --- a/docs/framework/svelte/reference/functions/createQuery.md +++ b/docs/framework/svelte/reference/functions/createQuery.md @@ -115,12 +115,13 @@ The same query, checking `isPending`/`isError` instead of `status` — pick whic function createQuery(options: Accessor>, queryClient?: Accessor): DefinedCreateQueryResult; ``` -Defined in: [packages/svelte-query/src/createQuery.ts:128](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQuery.ts#L128) +Defined in: [packages/svelte-query/src/createQuery.ts:129](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQuery.ts#L129) Subscribes to a query: a declarative dependency on an asynchronous source of data that is tied to a unique key. The query runs when the options call for it — `enabled: false` skips the initial fetch. -This overload is selected when `initialData` is set, so the resulting `data` is never `undefined`. +This overload is selected when `initialData` is set, so the resulting `data` is never `undefined` (unless +a `select` changes `TData` to include `undefined`). ### Type Parameters @@ -199,7 +200,7 @@ since `initialData` guarantees data upfront). `isSuccess`/`isError` are derived function createQuery(options: Accessor>, queryClient?: Accessor): CreateQueryResult; ``` -Defined in: [packages/svelte-query/src/createQuery.ts:254](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQuery.ts#L254) +Defined in: [packages/svelte-query/src/createQuery.ts:255](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQuery.ts#L255) ### Type Parameters diff --git a/docs/framework/svelte/reference/functions/queryOptions.md b/docs/framework/svelte/reference/functions/queryOptions.md index 4626c3f9ccc..fc6270c8e3e 100644 --- a/docs/framework/svelte/reference/functions/queryOptions.md +++ b/docs/framework/svelte/reference/functions/queryOptions.md @@ -9,13 +9,14 @@ title: queryOptions function queryOptions(options: DefinedInitialDataOptions): CreateQueryOptions & object & QueryKeyWithDataTag; ``` -Defined in: [packages/svelte-query/src/queryOptions.ts:68](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L68) +Defined in: [packages/svelte-query/src/queryOptions.ts:69](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L69) You can generally pass everything to `queryOptions` that you can also pass to `createQuery`. These options can be shared across `createQuery` calls and imperative APIs such as `queryClient.query`. `options.queryKey` is required and is the query key to generate options for. -This overload is selected when `initialData` is set, so the resulting `data` is never `undefined`. +This overload is selected when `initialData` is set, so the resulting `data` is never `undefined` (unless +a `select` changes `TData` to include `undefined`). ### Type Parameters @@ -87,7 +88,7 @@ The same options object, typed so that `queryKey` carries the inferred data type function queryOptions(options: UndefinedInitialDataOptions): CreateQueryOptions & object & QueryKeyWithDataTag; ``` -Defined in: [packages/svelte-query/src/queryOptions.ts:113](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L113) +Defined in: [packages/svelte-query/src/queryOptions.ts:114](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L114) You can generally pass everything to `queryOptions` that you can also pass to `createQuery`. These options can be shared across `createQuery` calls and imperative APIs such as `queryClient.query`. `options.queryKey` diff --git a/packages/svelte-query/src/createQuery.ts b/packages/svelte-query/src/createQuery.ts index 6a16e24edd4..1397334f177 100644 --- a/packages/svelte-query/src/createQuery.ts +++ b/packages/svelte-query/src/createQuery.ts @@ -90,7 +90,8 @@ export function createQuery< * Subscribes to a query: a declarative dependency on an asynchronous source of data that is tied to a unique key. * The query runs when the options call for it — `enabled: false` skips the initial fetch. * - * This overload is selected when `initialData` is set, so the resulting `data` is never `undefined`. + * This overload is selected when `initialData` is set, so the resulting `data` is never `undefined` (unless + * a `select` changes `TData` to include `undefined`). * * @see {@link queryOptions} to share these options between `createQuery` and imperative APIs like `queryClient.query`. * @param options - The {@link DefinedInitialDataOptions} to use — everything you can pass to `createQuery`, diff --git a/packages/svelte-query/src/queryOptions.ts b/packages/svelte-query/src/queryOptions.ts index 577a5d8c764..f7f04f0f332 100644 --- a/packages/svelte-query/src/queryOptions.ts +++ b/packages/svelte-query/src/queryOptions.ts @@ -32,7 +32,8 @@ export type DefinedInitialDataOptions< * can be shared across `createQuery` calls and imperative APIs such as `queryClient.query`. `options.queryKey` * is required and is the query key to generate options for. * - * This overload is selected when `initialData` is set, so the resulting `data` is never `undefined`. + * This overload is selected when `initialData` is set, so the resulting `data` is never `undefined` (unless + * a `select` changes `TData` to include `undefined`). * * @see {@link createQuery} to run a query with these options. * @param options - The {@link DefinedInitialDataOptions} to use — everything you can pass to `createQuery`,