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/svelte/reference/functions/createQuery.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,12 +115,13 @@ The same query, checking `isPending`/`isError` instead of `status` β€” pick whic
function createQuery<TQueryFnData, TError, TData, TQueryKey>(options: Accessor<DefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>>, queryClient?: Accessor<QueryClient>): DefinedCreateQueryResult<TData, TError>;
```

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

Expand Down Expand Up @@ -199,7 +200,7 @@ since `initialData` guarantees data upfront). `isSuccess`/`isError` are derived
function createQuery<TQueryFnData, TError, TData, TQueryKey>(options: Accessor<CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey>>, queryClient?: Accessor<QueryClient>): CreateQueryResult<TData, TError>;
```

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

Expand Down
7 changes: 4 additions & 3 deletions docs/framework/svelte/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>): CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & object & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
```

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

Expand Down Expand Up @@ -87,7 +88,7 @@ The same options object, typed so that `queryKey` carries the inferred data type
function queryOptions<TQueryFnData, TError, TData, TQueryKey>(options: UndefinedInitialDataOptions<TQueryFnData, TError, TData, TQueryKey>): CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> & object & QueryKeyWithDataTag<TQueryKey, TQueryFnData, TError>;
```

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