Skip to content

docs(svelte-query): regenerate reference docs to fix stale source line numbers #11399

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sukvvon merged 1 commit into from
Sep 5, 2026
Merged

docs(svelte-query): regenerate reference docs to fix stale source line numbers #11399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/type-aliases/Accessor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: Accessor
type Accessor<T> = () => T;
```

Defined in: [packages/svelte-query/src/types.ts:21](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L21)
Defined in: [packages/svelte-query/src/types.ts:22](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L22)

## Type Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/type-aliases/CreateBaseMutationResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ type CreateBaseMutationResult<TData, TError, TVariables, TOnMutateResult> = Over
}> & object;
```

Defined in: [packages/svelte-query/src/types.ts:114](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L114)
Defined in: [packages/svelte-query/src/types.ts:121](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L121)

## Type Declaration

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/type-aliases/CreateBaseQueryOptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: CreateBaseQueryOptions
type CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey> = QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
```

Defined in: [packages/svelte-query/src/types.ts:24](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L24)
Defined in: [packages/svelte-query/src/types.ts:25](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L25)

Options for createBaseQuery

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/type-aliases/CreateBaseQueryResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: CreateBaseQueryResult
type CreateBaseQueryResult<TData, TError> = QueryObserverResult<TData, TError>;
```

Defined in: [packages/svelte-query/src/types.ts:33](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L33)
Defined in: [packages/svelte-query/src/types.ts:34](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L34)

Result from createBaseQuery

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/type-aliases/CreateInfiniteQueryOptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: CreateInfiniteQueryOptions
type CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam> = InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>;
```

Defined in: [packages/svelte-query/src/types.ts:53](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L53)
Defined in: [packages/svelte-query/src/types.ts:54](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L54)

Options for createInfiniteQuery

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/type-aliases/CreateInfiniteQueryResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: CreateInfiniteQueryResult
type CreateInfiniteQueryResult<TData, TError> = InfiniteQueryObserverResult<TData, TError>;
```

Defined in: [packages/svelte-query/src/types.ts:68](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L68)
Defined in: [packages/svelte-query/src/types.ts:69](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L69)

Result from createInfiniteQuery

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/type-aliases/CreateMutateAsyncFunction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: CreateMutateAsyncFunction
type CreateMutateAsyncFunction<TData, TError, TVariables, TOnMutateResult> = MutateFunction<TData, TError, TVariables, TOnMutateResult>;
```

Defined in: [packages/svelte-query/src/types.ts:107](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L107)
Defined in: [packages/svelte-query/src/types.ts:114](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L114)

## Type Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/type-aliases/CreateMutateFunction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: CreateMutateFunction
type CreateMutateFunction<TData, TError, TVariables, TOnMutateResult> = (...args) => void;
```

Defined in: [packages/svelte-query/src/types.ts:96](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L96)
Defined in: [packages/svelte-query/src/types.ts:103](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L103)

## Type Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/type-aliases/CreateMutationOptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: CreateMutationOptions
type CreateMutationOptions<TData, TError, TVariables, TOnMutateResult> = OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TOnMutateResult>, "_defaulted">;
```

Defined in: [packages/svelte-query/src/types.ts:86](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L86)
Defined in: [packages/svelte-query/src/types.ts:93](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L93)

Options for createMutation

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/type-aliases/CreateMutationResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: CreateMutationResult
type CreateMutationResult<TData, TError, TVariables, TOnMutateResult> = CreateBaseMutationResult<TData, TError, TVariables, TOnMutateResult>;
```

Defined in: [packages/svelte-query/src/types.ts:132](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L132)
Defined in: [packages/svelte-query/src/types.ts:139](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L139)

Result from createMutation

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/type-aliases/CreateQueryOptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: CreateQueryOptions
type CreateQueryOptions<TQueryFnData, TError, TData, TQueryKey> = CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>;
```

Defined in: [packages/svelte-query/src/types.ts:39](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L39)
Defined in: [packages/svelte-query/src/types.ts:40](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L40)

Options for createQuery

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/type-aliases/CreateQueryResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: CreateQueryResult
type CreateQueryResult<TData, TError> = CreateBaseQueryResult<TData, TError>;
```

Defined in: [packages/svelte-query/src/types.ts:47](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L47)
Defined in: [packages/svelte-query/src/types.ts:48](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L48)

Result from createQuery

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/type-aliases/DefinedCreateBaseQueryResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: DefinedCreateBaseQueryResult
type DefinedCreateBaseQueryResult<TData, TError> = DefinedQueryObserverResult<TData, TError>;
```

Defined in: [packages/svelte-query/src/types.ts:74](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L74)
Defined in: [packages/svelte-query/src/types.ts:81](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L81)

Options for createBaseQuery with initialData

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/type-aliases/DefinedCreateQueryResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: DefinedCreateQueryResult
type DefinedCreateQueryResult<TData, TError> = DefinedCreateBaseQueryResult<TData, TError>;
```

Defined in: [packages/svelte-query/src/types.ts:80](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L80)
Defined in: [packages/svelte-query/src/types.ts:87](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L87)

Options for createQuery with initialData

Expand Down
6 changes: 3 additions & 3 deletions docs/framework/svelte/reference/type-aliases/MutationStateOptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: MutationStateOptions
type MutationStateOptions<TResult, TMutation> = object;
```

Defined in: [packages/svelte-query/src/types.ts:151](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L151)
Defined in: [packages/svelte-query/src/types.ts:158](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L158)

Options for useMutationState

Expand All @@ -29,7 +29,7 @@ Options for useMutationState
optional filters: MutationFilters;
```

Defined in: [packages/svelte-query/src/types.ts:156](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L156)
Defined in: [packages/svelte-query/src/types.ts:163](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L163)

***

Expand All @@ -39,7 +39,7 @@ Defined in: [packages/svelte-query/src/types.ts:156](https://github.com/TanStack
optional select: (mutation) => TResult;
```

Defined in: [packages/svelte-query/src/types.ts:157](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L157)
Defined in: [packages/svelte-query/src/types.ts:164](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L164)

#### Parameters

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/svelte/reference/type-aliases/MutationTypeFromResult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: MutationTypeFromResult
type MutationTypeFromResult<TResult> = [TResult] extends [MutationState<infer TData, infer TError, infer TVariables, infer TOnMutateResult>] ? Mutation<TData, TError, TVariables, TOnMutateResult> : Mutation;
```

Defined in: [packages/svelte-query/src/types.ts:139](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L139)
Defined in: [packages/svelte-query/src/types.ts:146](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L146)

## Type Parameters

Expand Down
6 changes: 3 additions & 3 deletions docs/framework/svelte/reference/type-aliases/QueryClientProviderProps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: QueryClientProviderProps
type QueryClientProviderProps = object;
```

Defined in: [packages/svelte-query/src/types.ts:160](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L160)
Defined in: [packages/svelte-query/src/types.ts:167](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L167)

## Properties

Expand All @@ -17,7 +17,7 @@ Defined in: [packages/svelte-query/src/types.ts:160](https://github.com/TanStack
children: Snippet;
```

Defined in: [packages/svelte-query/src/types.ts:162](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L162)
Defined in: [packages/svelte-query/src/types.ts:169](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L169)

***

Expand All @@ -27,4 +27,4 @@ Defined in: [packages/svelte-query/src/types.ts:162](https://github.com/TanStack
client: QueryClient;
```

Defined in: [packages/svelte-query/src/types.ts:161](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L161)
Defined in: [packages/svelte-query/src/types.ts:168](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L168)
Loading