From d09e283869091e81bc614498d4481599d409c432 Mon Sep 17 00:00:00 2001 From: Wonsuk Choi Date: Tue, 22 Sep 2026 15:31:17 +0900 Subject: [PATCH] docs(solid-query): correct 'initialData'/'select' JSDoc inaccuracy --- docs/framework/solid/reference/functions/queryOptions.md | 7 ++++--- docs/framework/solid/reference/functions/useQuery.md | 5 +++-- .../solid/reference/interfaces/InfiniteQueryOptions.md | 2 +- .../solid/reference/interfaces/MutationOptions.md | 2 +- .../type-aliases/DefinedInitialDataInfiniteOptions.md | 2 +- .../reference/type-aliases/DefinedInitialDataOptions.md | 2 +- .../reference/type-aliases/DefinedUseBaseQueryResult.md | 5 +++-- .../type-aliases/DefinedUseInfiniteQueryResult.md | 5 +++-- .../reference/type-aliases/DefinedUseQueryResult.md | 5 +++-- .../reference/type-aliases/UseBaseMutationResult.md | 2 +- .../reference/type-aliases/UseInfiniteQueryOptions.md | 2 +- .../reference/type-aliases/UseInfiniteQueryResult.md | 2 +- .../reference/type-aliases/UseMutateAsyncFunction.md | 2 +- .../solid/reference/type-aliases/UseMutateFunction.md | 2 +- .../solid/reference/type-aliases/UseMutationOptions.md | 2 +- .../solid/reference/type-aliases/UseMutationResult.md | 2 +- docs/framework/solid/reference/variables/createQuery.md | 3 ++- packages/solid-query/src/infiniteQueryOptions.ts | 2 +- packages/solid-query/src/queryOptions.ts | 5 +++-- packages/solid-query/src/types.ts | 9 ++++++--- packages/solid-query/src/useQuery.ts | 3 ++- 21 files changed, 41 insertions(+), 30 deletions(-) diff --git a/docs/framework/solid/reference/functions/queryOptions.md b/docs/framework/solid/reference/functions/queryOptions.md index 07b8c7d05c1..c586f4d70b3 100644 --- a/docs/framework/solid/reference/functions/queryOptions.md +++ b/docs/framework/solid/reference/functions/queryOptions.md @@ -11,13 +11,14 @@ redirect_from: function queryOptions(options: QueryOptions & object): QueryOptions & object & QueryKeyWithDataTag; ``` -Defined in: [packages/solid-query/src/queryOptions.ts:89](https://github.com/TanStack/query/blob/main/packages/solid-query/src/queryOptions.ts#L89) +Defined in: [packages/solid-query/src/queryOptions.ts:90](https://github.com/TanStack/query/blob/main/packages/solid-query/src/queryOptions.ts#L90) You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can be shared across hooks 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 @@ -89,7 +90,7 @@ function Posts() { function queryOptions(options: QueryOptions & object): QueryOptions & object & QueryKeyWithDataTag; ``` -Defined in: [packages/solid-query/src/queryOptions.ts:139](https://github.com/TanStack/query/blob/main/packages/solid-query/src/queryOptions.ts#L139) +Defined in: [packages/solid-query/src/queryOptions.ts:140](https://github.com/TanStack/query/blob/main/packages/solid-query/src/queryOptions.ts#L140) You can generally pass everything to `queryOptions` that you can also pass to `useQuery`. These options can be shared across hooks and imperative APIs such as `queryClient.query`. `options.queryKey` is required and diff --git a/docs/framework/solid/reference/functions/useQuery.md b/docs/framework/solid/reference/functions/useQuery.md index e102f8263d1..574b137a547 100644 --- a/docs/framework/solid/reference/functions/useQuery.md +++ b/docs/framework/solid/reference/functions/useQuery.md @@ -215,12 +215,13 @@ function Posts() { function useQuery(options: DefinedInitialDataOptions, queryClient?: () => QueryClient): DefinedUseQueryResult; ``` -Defined in: [packages/solid-query/src/useQuery.ts:232](https://github.com/TanStack/query/blob/main/packages/solid-query/src/useQuery.ts#L232) +Defined in: [packages/solid-query/src/useQuery.ts:233](https://github.com/TanStack/query/blob/main/packages/solid-query/src/useQuery.ts#L233) 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 diff --git a/docs/framework/solid/reference/interfaces/InfiniteQueryOptions.md b/docs/framework/solid/reference/interfaces/InfiniteQueryOptions.md index b889468536f..c6313088e05 100644 --- a/docs/framework/solid/reference/interfaces/InfiniteQueryOptions.md +++ b/docs/framework/solid/reference/interfaces/InfiniteQueryOptions.md @@ -3,7 +3,7 @@ id: InfiniteQueryOptions title: InfiniteQueryOptions --- -Defined in: [packages/solid-query/src/types.ts:158](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L158) +Defined in: [packages/solid-query/src/types.ts:160](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L160) The options accepted by `useInfiniteQuery`. diff --git a/docs/framework/solid/reference/interfaces/MutationOptions.md b/docs/framework/solid/reference/interfaces/MutationOptions.md index b8d13795e20..a1cdd9c7048 100644 --- a/docs/framework/solid/reference/interfaces/MutationOptions.md +++ b/docs/framework/solid/reference/interfaces/MutationOptions.md @@ -3,7 +3,7 @@ id: MutationOptions title: MutationOptions --- -Defined in: [packages/solid-query/src/types.ts:251](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L251) +Defined in: [packages/solid-query/src/types.ts:254](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L254) The options accepted by `useMutation` and `mutationOptions`. diff --git a/docs/framework/solid/reference/type-aliases/DefinedInitialDataInfiniteOptions.md b/docs/framework/solid/reference/type-aliases/DefinedInitialDataInfiniteOptions.md index bf0beab741b..4e48b9c74bb 100644 --- a/docs/framework/solid/reference/type-aliases/DefinedInitialDataInfiniteOptions.md +++ b/docs/framework/solid/reference/type-aliases/DefinedInitialDataInfiniteOptions.md @@ -10,7 +10,7 @@ type DefinedInitialDataInfiniteOptions = Accesso Defined in: [packages/solid-query/src/queryOptions.ts:40](https://github.com/TanStack/query/blob/main/packages/solid-query/src/queryOptions.ts#L40) The options accepted by the `queryOptions` overload selected when `initialData` is set — `data` is never -`undefined`. +`undefined` (unless a `select` changes `TData` to include `undefined`). ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/DefinedUseBaseQueryResult.md b/docs/framework/solid/reference/type-aliases/DefinedUseBaseQueryResult.md index 2cffe97de8e..c01cf298b80 100644 --- a/docs/framework/solid/reference/type-aliases/DefinedUseBaseQueryResult.md +++ b/docs/framework/solid/reference/type-aliases/DefinedUseBaseQueryResult.md @@ -7,9 +7,10 @@ title: DefinedUseBaseQueryResult type DefinedUseBaseQueryResult = DefinedQueryObserverResult; ``` -Defined in: [packages/solid-query/src/types.ts:132](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L132) +Defined in: [packages/solid-query/src/types.ts:133](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L133) -The object `useQuery` returns when `initialData` guarantees `data` is never `undefined`. +The object `useQuery` returns when `initialData` guarantees `data` is never `undefined` (unless a +`select` changes `TData` to include `undefined`). ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/DefinedUseInfiniteQueryResult.md b/docs/framework/solid/reference/type-aliases/DefinedUseInfiniteQueryResult.md index fe4050140e2..1f0fd83f8b3 100644 --- a/docs/framework/solid/reference/type-aliases/DefinedUseInfiniteQueryResult.md +++ b/docs/framework/solid/reference/type-aliases/DefinedUseInfiniteQueryResult.md @@ -7,9 +7,10 @@ title: DefinedUseInfiniteQueryResult type DefinedUseInfiniteQueryResult = DefinedInfiniteQueryObserverResult; ``` -Defined in: [packages/solid-query/src/types.ts:237](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L237) +Defined in: [packages/solid-query/src/types.ts:240](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L240) -The object `useInfiniteQuery` returns when `initialData` guarantees `data` is never `undefined`. +The object `useInfiniteQuery` returns when `initialData` guarantees `data` is never `undefined` (unless a +`select` changes `TData` to include `undefined`). ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/DefinedUseQueryResult.md b/docs/framework/solid/reference/type-aliases/DefinedUseQueryResult.md index 50e13c7b57e..fd7d74b88dd 100644 --- a/docs/framework/solid/reference/type-aliases/DefinedUseQueryResult.md +++ b/docs/framework/solid/reference/type-aliases/DefinedUseQueryResult.md @@ -7,9 +7,10 @@ title: DefinedUseQueryResult type DefinedUseQueryResult = DefinedUseBaseQueryResult; ``` -Defined in: [packages/solid-query/src/types.ts:143](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L143) +Defined in: [packages/solid-query/src/types.ts:145](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L145) -The object `useQuery` returns when `initialData` guarantees `data` is never `undefined`. +The object `useQuery` returns when `initialData` guarantees `data` is never `undefined` (unless a +`select` changes `TData` to include `undefined`). ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/UseBaseMutationResult.md b/docs/framework/solid/reference/type-aliases/UseBaseMutationResult.md index fd9954ce5fb..fd4d96aca2c 100644 --- a/docs/framework/solid/reference/type-aliases/UseBaseMutationResult.md +++ b/docs/framework/solid/reference/type-aliases/UseBaseMutationResult.md @@ -9,7 +9,7 @@ type UseBaseMutationResult = Overrid }> & object; ``` -Defined in: [packages/solid-query/src/types.ts:315](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L315) +Defined in: [packages/solid-query/src/types.ts:318](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L318) The result of `useMutation`. Same as [MutationObserverResult](MutationObserverResult.md) from `@tanstack/query-core`, with `mutate` narrowed to the fire-and-forget [UseMutateFunction](UseMutateFunction.md) signature, plus the added `mutateAsync`. diff --git a/docs/framework/solid/reference/type-aliases/UseInfiniteQueryOptions.md b/docs/framework/solid/reference/type-aliases/UseInfiniteQueryOptions.md index 8c756544f3e..1af979c7578 100644 --- a/docs/framework/solid/reference/type-aliases/UseInfiniteQueryOptions.md +++ b/docs/framework/solid/reference/type-aliases/UseInfiniteQueryOptions.md @@ -7,7 +7,7 @@ title: UseInfiniteQueryOptions type UseInfiniteQueryOptions = Accessor>; ``` -Defined in: [packages/solid-query/src/types.ts:209](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L209) +Defined in: [packages/solid-query/src/types.ts:211](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L211) The accessor `useInfiniteQuery` expects as its first argument — Solid re-evaluates it reactively, so `queryKey` and other options can depend on signals. diff --git a/docs/framework/solid/reference/type-aliases/UseInfiniteQueryResult.md b/docs/framework/solid/reference/type-aliases/UseInfiniteQueryResult.md index dd75bf907db..6e77e3647f6 100644 --- a/docs/framework/solid/reference/type-aliases/UseInfiniteQueryResult.md +++ b/docs/framework/solid/reference/type-aliases/UseInfiniteQueryResult.md @@ -7,7 +7,7 @@ title: UseInfiniteQueryResult type UseInfiniteQueryResult = InfiniteQueryObserverResult; ``` -Defined in: [packages/solid-query/src/types.ts:226](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L226) +Defined in: [packages/solid-query/src/types.ts:228](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L228) The object `useInfiniteQuery` returns — `data`/`error` may still be `undefined`/`null` while the query is `pending`. diff --git a/docs/framework/solid/reference/type-aliases/UseMutateAsyncFunction.md b/docs/framework/solid/reference/type-aliases/UseMutateAsyncFunction.md index b1cd87dc5ad..8f83a66ae41 100644 --- a/docs/framework/solid/reference/type-aliases/UseMutateAsyncFunction.md +++ b/docs/framework/solid/reference/type-aliases/UseMutateAsyncFunction.md @@ -7,7 +7,7 @@ title: UseMutateAsyncFunction type UseMutateAsyncFunction = MutateFunction; ``` -Defined in: [packages/solid-query/src/types.ts:298](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L298) +Defined in: [packages/solid-query/src/types.ts:301](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L301) The type of `mutateAsync`, as returned by `useMutation`. Similar to [UseMutateFunction](UseMutateFunction.md), but returns a promise which can be awaited. diff --git a/docs/framework/solid/reference/type-aliases/UseMutateFunction.md b/docs/framework/solid/reference/type-aliases/UseMutateFunction.md index 118264513e9..4182a788d93 100644 --- a/docs/framework/solid/reference/type-aliases/UseMutateFunction.md +++ b/docs/framework/solid/reference/type-aliases/UseMutateFunction.md @@ -7,7 +7,7 @@ title: UseMutateFunction type UseMutateFunction = (...args: Parameters>) => void; ``` -Defined in: [packages/solid-query/src/types.ts:277](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L277) +Defined in: [packages/solid-query/src/types.ts:280](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L280) ## Type Parameters diff --git a/docs/framework/solid/reference/type-aliases/UseMutationOptions.md b/docs/framework/solid/reference/type-aliases/UseMutationOptions.md index 4ca36e600c6..75c8e902a9d 100644 --- a/docs/framework/solid/reference/type-aliases/UseMutationOptions.md +++ b/docs/framework/solid/reference/type-aliases/UseMutationOptions.md @@ -7,7 +7,7 @@ title: UseMutationOptions type UseMutationOptions = Accessor>; ``` -Defined in: [packages/solid-query/src/types.ts:270](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L270) +Defined in: [packages/solid-query/src/types.ts:273](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L273) The accessor `useMutation` expects as its first argument — Solid re-evaluates it reactively, so callbacks and other options can depend on signals. diff --git a/docs/framework/solid/reference/type-aliases/UseMutationResult.md b/docs/framework/solid/reference/type-aliases/UseMutationResult.md index ec358b8d9a2..d8b0f09bdbe 100644 --- a/docs/framework/solid/reference/type-aliases/UseMutationResult.md +++ b/docs/framework/solid/reference/type-aliases/UseMutationResult.md @@ -7,7 +7,7 @@ title: UseMutationResult type UseMutationResult = UseBaseMutationResult; ``` -Defined in: [packages/solid-query/src/types.ts:344](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L344) +Defined in: [packages/solid-query/src/types.ts:347](https://github.com/TanStack/query/blob/main/packages/solid-query/src/types.ts#L347) The result of `useMutation`. Same as [UseBaseMutationResult](UseBaseMutationResult.md). diff --git a/docs/framework/solid/reference/variables/createQuery.md b/docs/framework/solid/reference/variables/createQuery.md index ab8c83ce07a..1f53bb2be7f 100644 --- a/docs/framework/solid/reference/variables/createQuery.md +++ b/docs/framework/solid/reference/variables/createQuery.md @@ -223,7 +223,8 @@ function Posts() { 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 diff --git a/packages/solid-query/src/infiniteQueryOptions.ts b/packages/solid-query/src/infiniteQueryOptions.ts index 5ff531c766c..78cb5d693cf 100644 --- a/packages/solid-query/src/infiniteQueryOptions.ts +++ b/packages/solid-query/src/infiniteQueryOptions.ts @@ -36,7 +36,7 @@ export type UndefinedInitialDataInfiniteOptions< /** * The options accepted by the `infiniteQueryOptions` overload selected when `initialData` is set — `data` is - * never `undefined`. + * never `undefined` (unless a `select` changes `TData` to include `undefined`). * * @template TQueryFnData - The type of a single page, as your `queryFn` resolves it. * @template TError - The type of errors your `queryFn` may throw. diff --git a/packages/solid-query/src/queryOptions.ts b/packages/solid-query/src/queryOptions.ts index 5a5bbb71753..6b6eca2394b 100644 --- a/packages/solid-query/src/queryOptions.ts +++ b/packages/solid-query/src/queryOptions.ts @@ -30,7 +30,7 @@ export type UndefinedInitialDataOptions< /** * The options accepted by the `queryOptions` overload selected when `initialData` is set — `data` is never - * `undefined`. + * `undefined` (unless a `select` changes `TData` to include `undefined`). * * @template TQueryFnData - The type your `queryFn` resolves to. * @template TError - The type of errors your `queryFn` may throw. @@ -53,7 +53,8 @@ export type DefinedInitialDataOptions< * be shared across hooks 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 useQuery} to run a query with these options. * @param options - The {@link DefinedInitialDataOptions} to use — everything you can pass to `useQuery`, with `initialData` set. diff --git a/packages/solid-query/src/types.ts b/packages/solid-query/src/types.ts index 1aad7cf4332..c061af8f4f9 100644 --- a/packages/solid-query/src/types.ts +++ b/packages/solid-query/src/types.ts @@ -124,7 +124,8 @@ export type UseQueryResult< > = UseBaseQueryResult /** - * The object `useQuery` returns when `initialData` guarantees `data` is never `undefined`. + * The object `useQuery` returns when `initialData` guarantees `data` is never `undefined` (unless a + * `select` changes `TData` to include `undefined`). * * @template TData - The type `data` ends up as, after `select` runs (if set). * @template TError - The type of errors this query may hold. @@ -135,7 +136,8 @@ export type DefinedUseBaseQueryResult< > = DefinedQueryObserverResult /** - * The object `useQuery` returns when `initialData` guarantees `data` is never `undefined`. + * The object `useQuery` returns when `initialData` guarantees `data` is never `undefined` (unless a + * `select` changes `TData` to include `undefined`). * * @template TData - The type `data` ends up as, after `select` runs (if set). * @template TError - The type of errors this query may hold. @@ -229,7 +231,8 @@ export type UseInfiniteQueryResult< > = InfiniteQueryObserverResult /** - * The object `useInfiniteQuery` returns when `initialData` guarantees `data` is never `undefined`. + * The object `useInfiniteQuery` returns when `initialData` guarantees `data` is never `undefined` (unless a + * `select` changes `TData` to include `undefined`). * * @template TData - The type `data` ends up as, after `select` runs (if set). * @template TError - The type of errors this query may hold. diff --git a/packages/solid-query/src/useQuery.ts b/packages/solid-query/src/useQuery.ts index edfdb6a07e3..2b098827bdc 100644 --- a/packages/solid-query/src/useQuery.ts +++ b/packages/solid-query/src/useQuery.ts @@ -192,7 +192,8 @@ export function useQuery< * 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 `useQuery` and imperative APIs like `queryClient.query`. * @param options - An accessor returning the {@link DefinedInitialDataOptions} to use — everything you can