Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/framework/preact/reference/functions/queryOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,14 @@ title: queryOptions
function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): Omit<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryFn"> & object & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
```

Defined in: [packages/preact-query/src/queryOptions.ts:143](https://github.com/TanStack/query/blob/main/packages/preact-query/src/queryOptions.ts#L143)
Defined in: [packages/preact-query/src/queryOptions.ts:144](https://github.com/TanStack/query/blob/main/packages/preact-query/src/queryOptions.ts#L144)

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

Expand Down Expand Up @@ -85,7 +86,7 @@ function Posts() {
function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options: UnusedSkipTokenOptions<TQueryFnData, TError, TData, TQueryKey>): OmitKeyof<UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, "queryFn"> & object & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
```

Defined in: [packages/preact-query/src/queryOptions.ts:184](https://github.com/TanStack/query/blob/main/packages/preact-query/src/queryOptions.ts#L184)
Defined in: [packages/preact-query/src/queryOptions.ts:185](https://github.com/TanStack/query/blob/main/packages/preact-query/src/queryOptions.ts#L185)

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
Expand Down Expand Up @@ -154,7 +155,7 @@ function Post({ id }: { id: string }) {
function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): UseQueryOptions<TQueryFnData, TError, TData, TQueryKey> & object & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
```

Defined in: [packages/preact-query/src/queryOptions.ts:248](https://github.com/TanStack/query/blob/main/packages/preact-query/src/queryOptions.ts#L248)
Defined in: [packages/preact-query/src/queryOptions.ts:249](https://github.com/TanStack/query/blob/main/packages/preact-query/src/queryOptions.ts#L249)

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
Expand Down
2 changes: 1 addition & 1 deletion docs/framework/preact/reference/functions/useQueries.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: useQueries
function useQueries<T, TCombinedResult>(__namedParameters: object, queryClient?: QueryClient): TCombinedResult;
```

Defined in: [packages/preact-query/src/useQueries.ts:302](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQueries.ts#L302)
Defined in: [packages/preact-query/src/useQueries.ts:306](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQueries.ts#L306)

The `useQueries` hook can be used to fetch a variable number of queries.

Expand Down
9 changes: 5 additions & 4 deletions docs/framework/preact/reference/functions/useQuery.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,10 @@ title: useQuery
function useQuery<TQueryFnData, TError, TData, TQueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError>;
```

Defined in: [packages/preact-query/src/useQuery.ts:50](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQuery.ts#L50)
Defined in: [packages/preact-query/src/useQuery.ts:51](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQuery.ts#L51)

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

Expand Down Expand Up @@ -89,7 +90,7 @@ function Posts() {
function useQuery<TQueryFnData, TError, TData, TQueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): UseQueryResult<TData, TError>;
```

Defined in: [packages/preact-query/src/useQuery.ts:117](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQuery.ts#L117)
Defined in: [packages/preact-query/src/useQuery.ts:118](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQuery.ts#L118)

### Type Parameters

Expand Down Expand Up @@ -190,7 +191,7 @@ function Posts() {
function useQuery<TQueryFnData, TError, TData, TQueryKey>(options: UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: QueryClient): UseQueryResult<TData, TError>;
```

Defined in: [packages/preact-query/src/useQuery.ts:281](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQuery.ts#L281)
Defined in: [packages/preact-query/src/useQuery.ts:282](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQuery.ts#L282)

### Type Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: useSuspenseQueries
function useSuspenseQueries<T, TCombinedResult>(options: object, queryClient?: QueryClient): TCombinedResult;
```

Defined in: [packages/preact-query/src/useSuspenseQueries.ts:409](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useSuspenseQueries.ts#L409)
Defined in: [packages/preact-query/src/useSuspenseQueries.ts:413](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useSuspenseQueries.ts#L413)

The options for `useSuspenseQueries` are the same as for `useQueries`, except that the top-level `subscribed`
option isn't supported, and each `query` can't have `throwOnError`, `enabled`, or `placeholderData`.
Expand Down Expand Up @@ -279,7 +279,7 @@ function ErrorBoundary({
function useSuspenseQueries<T, TCombinedResult>(options: object, queryClient?: QueryClient): TCombinedResult;
```

Defined in: [packages/preact-query/src/useSuspenseQueries.ts:589](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useSuspenseQueries.ts#L589)
Defined in: [packages/preact-query/src/useSuspenseQueries.ts:593](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useSuspenseQueries.ts#L593)

The options for `useSuspenseQueries` are the same as for `useQueries`, except that the top-level `subscribed`
option isn't supported, and each `query` can't have `throwOnError`, `enabled`, or `placeholderData`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: UseMutationOptions
title: UseMutationOptions
---

Defined in: [packages/preact-query/src/types.ts:411](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L411)
Defined in: [packages/preact-query/src/types.ts:412](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L412)

The options accepted by `useMutation`. Same as [MutationObserverOptions](MutationObserverOptions.md) from `@tanstack/query-core`,
minus the internal `_defaulted` flag.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: AnyUseMutationOptions
type AnyUseMutationOptions = UseMutationOptions<any, any, any, any>;
```

Defined in: [packages/preact-query/src/types.ts:400](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L400)
Defined in: [packages/preact-query/src/types.ts:401](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L401)

[UseMutationOptions](../interfaces/UseMutationOptions.md) with all type parameters set to `any`, useful when the specific types aren't
relevant, e.g. when accepting options for any mutation in a helper function.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ type DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, T
Defined in: [packages/preact-query/src/infiniteQueryOptions.ts:104](https://github.com/TanStack/query/blob/main/packages/preact-query/src/infiniteQueryOptions.ts#L104)

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`).

## Type Declaration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ type DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> = Omit<Us
Defined in: [packages/preact-query/src/queryOptions.ts:81](https://github.com/TanStack/query/blob/main/packages/preact-query/src/queryOptions.ts#L81)

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 Declaration

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ title: DefinedUseInfiniteQueryResult
type DefinedUseInfiniteQueryResult<TData, TError> = DefinedInfiniteQueryObserverResult<TData, TError>;
```

Defined in: [packages/preact-query/src/types.ts:376](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L376)
Defined in: [packages/preact-query/src/types.ts:377](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L377)

The result of `useInfiniteQuery` when `initialData` is set β€” `data` is never `undefined`. Re-exports
[DefinedInfiniteQueryObserverResult](DefinedInfiniteQueryObserverResult.md) from `@tanstack/query-core`.
The result of `useInfiniteQuery` when `initialData` is set β€” `data` is never `undefined` (unless a
`select` changes `TData` to include `undefined`). Re-exports [DefinedInfiniteQueryObserverResult](DefinedInfiniteQueryObserverResult.md)
from `@tanstack/query-core`.

## Type Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ type DefinedUseQueryResult<TData, TError> = DefinedQueryObserverResult<TData, TE
Defined in: [packages/preact-query/src/types.ts:352](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L352)

The result of `useQuery` when `initialData` is set, or of `useSuspenseQuery` before the `isPlaceholderData`
omission β€” `data` is never `undefined`. Re-exports [DefinedQueryObserverResult](DefinedQueryObserverResult.md) from
`@tanstack/query-core`.
omission β€” `data` is never `undefined` (unless a `select` changes `TData` to include `undefined`).
Re-exports [DefinedQueryObserverResult](DefinedQueryObserverResult.md) from `@tanstack/query-core`.

## Type Parameters

Expand Down
10 changes: 7 additions & 3 deletions docs/framework/preact/reference/type-aliases/QueriesOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,17 @@ title: QueriesOptions
type QueriesOptions<T, TResults, TDepth> = TDepth["length"] extends MAXIMUM_DEPTH ? UseQueryOptionsForUseQueries[] : T extends [] ? [] : T extends [infer Head] ? [...TResults, GetUseQueryOptionsForUseQueries<Head>] : T extends [infer Head, ...(infer Tails)] ? QueriesOptions<[...Tails], [...TResults, GetUseQueryOptionsForUseQueries<Head>], [...TDepth, 1]> : ReadonlyArray<unknown> extends T ? T : T extends UseQueryOptionsForUseQueries<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>[] ? UseQueryOptionsForUseQueries<TQueryFnData, TError, TData, TQueryKey>[] : UseQueryOptionsForUseQueries[];
```

Defined in: [packages/preact-query/src/useQueries.ts:156](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQueries.ts#L156)
Defined in: [packages/preact-query/src/useQueries.ts:160](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQueries.ts#L160)

The `queries` array accepted by `useQueries`. Recursively unwraps each tuple element so every entry's
`queryFn`/`select`/`throwOnError` are inferred individually, up to 20 elements. An opaque array (e.g.
`unknown[]`) is returned as-is; a non-tuple array of a known element type, or a tuple past 20 elements, falls
`queryFn`/`select`/`throwOnError` are inferred individually, up to 20 elements β€” past that, a tuple falls
back to a single homogeneous options type.

An opaque array (e.g. `unknown[]`) is returned as-is; a non-tuple array whose element type structurally
matches a query options object is mapped per-element instead, still inferring each entry individually; any
other non-tuple array β€” one whose element type doesn't match the expected options shape β€” falls back to
that same homogeneous options type too.

## Type Parameters

### T
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: QueriesResults
type QueriesResults<T, TResults, TDepth> = TDepth["length"] extends MAXIMUM_DEPTH ? UseQueryResult[] : T extends [] ? [] : T extends [infer Head] ? [...TResults, GetUseQueryResult<Head>] : T extends [infer Head, ...(infer Tails)] ? QueriesResults<[...Tails], [...TResults, GetUseQueryResult<Head>], [...TDepth, 1]> : { [K in keyof T]: GetUseQueryResult<T[K]> };
```

Defined in: [packages/preact-query/src/useQueries.ts:207](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQueries.ts#L207)
Defined in: [packages/preact-query/src/useQueries.ts:211](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useQueries.ts#L211)

The result type returned by `useQueries`, when no `combine` is provided. Mirrors [QueriesOptions](QueriesOptions.md): each
tuple element's result type is inferred individually, up to 20 elements. A non-tuple array is mapped
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,16 @@ title: SuspenseQueriesOptions
type SuspenseQueriesOptions<T, TResults, TDepth> = TDepth["length"] extends MAXIMUM_DEPTH ? UseSuspenseQueryOptions[] : T extends [] ? [] : T extends [infer Head] ? [...TResults, GetUseSuspenseQueryOptions<Head>] : T extends [infer Head, ...(infer Tails)] ? SuspenseQueriesOptions<[...Tails], [...TResults, GetUseSuspenseQueryOptions<Head>], [...TDepth, 1]> : unknown[] extends T ? T : T extends UseSuspenseQueryOptions<infer TQueryFnData, infer TError, infer TData, infer TQueryKey>[] ? UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[] : UseSuspenseQueryOptions[];
```

Defined in: [packages/preact-query/src/useSuspenseQueries.ts:119](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useSuspenseQueries.ts#L119)
Defined in: [packages/preact-query/src/useSuspenseQueries.ts:123](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useSuspenseQueries.ts#L123)

The `queries` array accepted by `useSuspenseQueries`. Recursively unwraps each tuple element so every
entry's `queryFn`/`select` are inferred individually, up to 20 elements. An opaque array (e.g. `unknown[]`)
is returned as-is; a non-tuple array of a known element type, or a tuple past 20 elements, falls back to a
single homogeneous [UseSuspenseQueryOptions](../interfaces/UseSuspenseQueryOptions.md) type.
entry's `queryFn`/`select` are inferred individually, up to 20 elements β€” past that, a tuple falls back to
a single homogeneous [UseSuspenseQueryOptions](../interfaces/UseSuspenseQueryOptions.md) type.

An opaque array (e.g. `unknown[]`) is returned as-is; a non-tuple array whose element type structurally
matches a query options object is mapped per-element instead, still inferring each entry individually; any
other non-tuple array β€” one whose element type doesn't match the expected options shape β€” falls back to
that same homogeneous options type too.

## Type Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: SuspenseQueriesResults
type SuspenseQueriesResults<T, TResults, TDepth> = TDepth["length"] extends MAXIMUM_DEPTH ? UseSuspenseQueryResult[] : T extends [] ? [] : T extends [infer Head] ? [...TResults, GetUseSuspenseQueryResult<Head>] : T extends [infer Head, ...(infer Tails)] ? SuspenseQueriesResults<[...Tails], [...TResults, GetUseSuspenseQueryResult<Head>], [...TDepth, 1]> : { [K in keyof T]: GetUseSuspenseQueryResult<T[K]> };
```

Defined in: [packages/preact-query/src/useSuspenseQueries.ts:165](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useSuspenseQueries.ts#L165)
Defined in: [packages/preact-query/src/useSuspenseQueries.ts:169](https://github.com/TanStack/query/blob/main/packages/preact-query/src/useSuspenseQueries.ts#L169)

The result type returned by `useSuspenseQueries`, when no `combine` is provided. Mirrors
[SuspenseQueriesOptions](SuspenseQueriesOptions.md): each tuple element's result type is inferred individually, up to 20 elements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ type UseBaseMutationResult<TData, TError, TVariables, TOnMutateResult> = Overrid
}> & object;
```

Defined in: [packages/preact-query/src/types.ts:470](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L470)
Defined in: [packages/preact-query/src/types.ts:471](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L471)

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`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: UseMutateAsyncFunction
type UseMutateAsyncFunction<TData, TError, TVariables, TOnMutateResult> = MutateFunction<TData, TError, TVariables, TOnMutateResult>;
```

Defined in: [packages/preact-query/src/types.ts:453](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L453)
Defined in: [packages/preact-query/src/types.ts:454](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L454)

The type of `mutateAsync`, as returned by `useMutation`. Similar to [UseMutateFunction](UseMutateFunction.md), but returns a
promise which can be awaited.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: UseMutateFunction
type UseMutateFunction<TData, TError, TVariables, TOnMutateResult> = (...args: Parameters<MutateFunction<TData, TError, TVariables, TOnMutateResult>>) => void;
```

Defined in: [packages/preact-query/src/types.ts:432](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L432)
Defined in: [packages/preact-query/src/types.ts:433](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L433)

The type of `mutate`, as returned by `useMutation`. Forwards the variables (and an optional per-call
`onSuccess`/`onError`/`onSettled`) to the underlying `mutate` call. Fire-and-forget β€” errors are surfaced
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: UseMutationResult
type UseMutationResult<TData, TError, TVariables, TOnMutateResult> = UseBaseMutationResult<TData, TError, TVariables, TOnMutateResult>;
```

Defined in: [packages/preact-query/src/types.ts:499](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L499)
Defined in: [packages/preact-query/src/types.ts:500](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L500)

The result of `useMutation`. Same as [UseBaseMutationResult](UseBaseMutationResult.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: UseSuspenseInfiniteQueryResult
type UseSuspenseInfiniteQueryResult<TData, TError> = OmitKeyof<DefinedInfiniteQueryObserverResult<TData, TError>, "isPlaceholderData">;
```

Defined in: [packages/preact-query/src/types.ts:388](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L388)
Defined in: [packages/preact-query/src/types.ts:389](https://github.com/TanStack/query/blob/main/packages/preact-query/src/types.ts#L389)

The result of `useSuspenseInfiniteQuery`. Same as [DefinedUseInfiniteQueryResult](DefinedUseInfiniteQueryResult.md), minus
`isPlaceholderData` β€” Suspense hooks never render placeholder data.
Expand Down
Loading
Loading