Skip to content
Merged
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
7 changes: 4 additions & 3 deletions docs/framework/solid/reference/functions/queryOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,14 @@ redirect_from:
function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options: QueryOptions<TQueryFnData, TError, TData, TQueryKey> & object): QueryOptions<TQueryFnData, TError, TData, TQueryKey> & object & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
```

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

Expand Down Expand Up @@ -89,7 +90,7 @@ function Posts() {
function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options: QueryOptions<TQueryFnData, TError, TData, TQueryKey> & object): QueryOptions<TQueryFnData, TError, TData, TQueryKey> & object & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
```

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
Expand Down
5 changes: 3 additions & 2 deletions docs/framework/solid/reference/functions/useQuery.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,12 +215,13 @@ function Posts() {
function useQuery<TQueryFnData, TError, TData, TQueryKey>(options: DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>, queryClient?: () => QueryClient): DefinedUseQueryResult<TData, TError>;
```

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
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/solid-query/src/infiniteQueryOptions.ts:48](https://github.com/TanStack/query/blob/main/packages/solid-query/src/infiniteQueryOptions.ts#L48)

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 Parameters

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ type DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey> = 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

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

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

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

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

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

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

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/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`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: UseInfiniteQueryOptions
type UseInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> = Accessor<InfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>>;
```

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

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: UseMutationOptions
type UseMutationOptions<TData, TError, TVariables, TOnMutateResult> = Accessor<MutationOptions<TData, TError, TVariables, TOnMutateResult>>;
```

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

Expand Down
3 changes: 2 additions & 1 deletion docs/framework/solid/reference/variables/createQuery.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/solid-query/src/infiniteQueryOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 3 additions & 2 deletions packages/solid-query/src/queryOptions.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down
9 changes: 6 additions & 3 deletions packages/solid-query/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,8 @@ export type UseQueryResult<
> = UseBaseQueryResult<TData, TError>

/**
* 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.
Expand All @@ -135,7 +136,8 @@ export type DefinedUseBaseQueryResult<
> = DefinedQueryObserverResult<TData, TError>

/**
* 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.
Expand Down Expand Up @@ -229,7 +231,8 @@ export type UseInfiniteQueryResult<
> = InfiniteQueryObserverResult<TData, TError>

/**
* 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.
Expand Down
3 changes: 2 additions & 1 deletion packages/solid-query/src/useQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading