Skip to content

Commit 13817e9

Browse files
lachlancollinslachlancollins
authored
docs(svelte-query): Auto-generate reference docs (#7751)
* docs(svelte-query): Auto-generate reference docs * Fix knip, update exclude
1 parent 81ca333 commit 13817e9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+1556
-127
lines changed

‎docs/config.json

+17
Original file line numberDiff line numberDiff line change
@@ -737,6 +737,23 @@
737737
"to": "framework/solid/reference/createQuery"
738738
}
739739
]
740+
},
741+
{
742+
"label": "svelte",
743+
"children": [
744+
{
745+
"label": "Svelte Reference",
746+
"to": "framework/svelte/reference/index"
747+
},
748+
{
749+
"label": "Functions / createQuery",
750+
"to": "framework/svelte/reference/createquery"
751+
},
752+
{
753+
"label": "Functions / createMutation",
754+
"to": "framework/svelte/reference/createmutation"
755+
}
756+
]
740757
}
741758
]
742759
},

‎docs/framework/svelte/reference/createbasemutationresult.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Type Alias: CreateBaseMutationResult\<TData, TError, TVariables, TContext\>
2+
3+
```ts
4+
type CreateBaseMutationResult<TData, TError, TVariables, TContext>: Override<MutationObserverResult<TData, TError, TVariables, TContext>, object> & object;
5+
```
6+
7+
## Type declaration
8+
9+
### mutateAsync
10+
11+
```ts
12+
mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>
13+
```
14+
15+
## Type Parameters
16+
17+
• **TData** = `unknown`
18+
19+
• **TError** = `DefaultError`
20+
21+
• **TVariables** = `unknown`
22+
23+
• **TContext** = `unknown`
24+
25+
## Defined in
26+
27+
[packages/svelte-query/src/types.ts:113](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L113)

‎docs/framework/svelte/reference/createbasequeryoptions.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Type Alias: CreateBaseQueryOptions\<TQueryFnData, TError, TData, TQueryData, TQueryKey\>
2+
3+
```ts
4+
type CreateBaseQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>: QueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey>;
5+
```
6+
7+
Options for createBaseQuery
8+
9+
## Type Parameters
10+
11+
• **TQueryFnData** = `unknown`
12+
13+
• **TError** = `DefaultError`
14+
15+
• **TData** = `TQueryFnData`
16+
17+
• **TQueryData** = `TQueryFnData`
18+
19+
• **TQueryKey** _extends_ `QueryKey` = `QueryKey`
20+
21+
## Defined in
22+
23+
[packages/svelte-query/src/types.ts:23](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L23)

‎docs/framework/svelte/reference/createbasequeryresult.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Type Alias: CreateBaseQueryResult\<TData, TError\>
2+
3+
```ts
4+
type CreateBaseQueryResult<TData, TError>: Readable<QueryObserverResult<TData, TError>>;
5+
```
6+
7+
Result from createBaseQuery
8+
9+
## Type Parameters
10+
11+
• **TData** = `unknown`
12+
13+
• **TError** = `DefaultError`
14+
15+
## Defined in
16+
17+
[packages/svelte-query/src/types.ts:32](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L32)

‎docs/framework/svelte/reference/createinfinitequery.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Function: createInfiniteQuery()
2+
3+
```ts
4+
function createInfiniteQuery<
5+
TQueryFnData,
6+
TError,
7+
TData,
8+
TQueryKey,
9+
TPageParam,
10+
>(options, queryClient?): CreateInfiniteQueryResult<TData, TError>
11+
```
12+
13+
## Type Parameters
14+
15+
• **TQueryFnData**
16+
17+
• **TError** = `Error`
18+
19+
• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\>
20+
21+
• **TQueryKey** _extends_ `QueryKey` = `QueryKey`
22+
23+
• **TPageParam** = `unknown`
24+
25+
## Parameters
26+
27+
• **options**: [`StoreOrVal`](storeorval.md)\<[`CreateInfiniteQueryOptions`](createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\>\>
28+
29+
• **queryClient?**: `QueryClient`
30+
31+
## Returns
32+
33+
[`CreateInfiniteQueryResult`](createinfinitequeryresult.md)\<`TData`, `TError`\>
34+
35+
## Defined in
36+
37+
[packages/svelte-query/src/createInfiniteQuery.ts:16](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createInfiniteQuery.ts#L16)

‎docs/framework/svelte/reference/createinfinitequeryoptions.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Type Alias: CreateInfiniteQueryOptions\<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam\>
2+
3+
```ts
4+
type CreateInfiniteQueryOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>: InfiniteQueryObserverOptions<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam>;
5+
```
6+
7+
Options for createInfiniteQuery
8+
9+
## Type Parameters
10+
11+
• **TQueryFnData** = `unknown`
12+
13+
• **TError** = `DefaultError`
14+
15+
• **TData** = `TQueryFnData`
16+
17+
• **TQueryData** = `TQueryFnData`
18+
19+
• **TQueryKey** _extends_ `QueryKey` = `QueryKey`
20+
21+
• **TPageParam** = `unknown`
22+
23+
## Defined in
24+
25+
[packages/svelte-query/src/types.ts:52](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L52)

‎docs/framework/svelte/reference/createinfinitequeryresult.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Type Alias: CreateInfiniteQueryResult\<TData, TError\>
2+
3+
```ts
4+
type CreateInfiniteQueryResult<TData, TError>: Readable<InfiniteQueryObserverResult<TData, TError>>;
5+
```
6+
7+
Result from createInfiniteQuery
8+
9+
## Type Parameters
10+
11+
• **TData** = `unknown`
12+
13+
• **TError** = `DefaultError`
14+
15+
## Defined in
16+
17+
[packages/svelte-query/src/types.ts:69](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L69)

‎docs/framework/svelte/reference/createmutateasyncfunction.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Type Alias: CreateMutateAsyncFunction\<TData, TError, TVariables, TContext\>
2+
3+
```ts
4+
type CreateMutateAsyncFunction<TData, TError, TVariables, TContext>: MutateFunction<TData, TError, TVariables, TContext>;
5+
```
6+
7+
## Type Parameters
8+
9+
• **TData** = `unknown`
10+
11+
• **TError** = `DefaultError`
12+
13+
• **TVariables** = `void`
14+
15+
• **TContext** = `unknown`
16+
17+
## Defined in
18+
19+
[packages/svelte-query/src/types.ts:106](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L106)

‎docs/framework/svelte/reference/createmutatefunction.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Type Alias: CreateMutateFunction()\<TData, TError, TVariables, TContext\>
2+
3+
```ts
4+
type CreateMutateFunction<TData, TError, TVariables, TContext>: (...args) => void;
5+
```
6+
7+
## Type Parameters
8+
9+
• **TData** = `unknown`
10+
11+
• **TError** = `DefaultError`
12+
13+
• **TVariables** = `void`
14+
15+
• **TContext** = `unknown`
16+
17+
## Parameters
18+
19+
• ...**args**: `Parameters`\<`MutateFunction`\<`TData`, `TError`, `TVariables`, `TContext`\>\>
20+
21+
## Returns
22+
23+
`void`
24+
25+
## Defined in
26+
27+
[packages/svelte-query/src/types.ts:97](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L97)

‎docs/framework/svelte/reference/createmutation.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Function: createMutation()
2+
3+
```ts
4+
function createMutation<TData, TError, TVariables, TContext>(
5+
options,
6+
queryClient?,
7+
): CreateMutationResult<TData, TError, TVariables, TContext>
8+
```
9+
10+
## Type Parameters
11+
12+
• **TData** = `unknown`
13+
14+
• **TError** = `Error`
15+
16+
• **TVariables** = `void`
17+
18+
• **TContext** = `unknown`
19+
20+
## Parameters
21+
22+
• **options**: [`StoreOrVal`](storeorval.md)\<[`CreateMutationOptions`](createmutationoptions.md)\<`TData`, `TError`, `TVariables`, `TContext`\>\>
23+
24+
• **queryClient?**: `QueryClient`
25+
26+
## Returns
27+
28+
[`CreateMutationResult`](createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TContext`\>
29+
30+
## Defined in
31+
32+
[packages/svelte-query/src/createMutation.ts:13](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createMutation.ts#L13)

‎docs/framework/svelte/reference/createmutationoptions.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Type Alias: CreateMutationOptions\<TData, TError, TVariables, TContext\>
2+
3+
```ts
4+
type CreateMutationOptions<TData, TError, TVariables, TContext>: OmitKeyof<MutationObserverOptions<TData, TError, TVariables, TContext>, "_defaulted">;
5+
```
6+
7+
Options for createMutation
8+
9+
## Type Parameters
10+
11+
• **TData** = `unknown`
12+
13+
• **TError** = `DefaultError`
14+
15+
• **TVariables** = `void`
16+
17+
• **TContext** = `unknown`
18+
19+
## Defined in
20+
21+
[packages/svelte-query/src/types.ts:87](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L87)

‎docs/framework/svelte/reference/createmutationresult.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Type Alias: CreateMutationResult\<TData, TError, TVariables, TContext\>
2+
3+
```ts
4+
type CreateMutationResult<TData, TError, TVariables, TContext>: Readable<CreateBaseMutationResult<TData, TError, TVariables, TContext>>;
5+
```
6+
7+
Result from createMutation
8+
9+
## Type Parameters
10+
11+
• **TData** = `unknown`
12+
13+
• **TError** = `DefaultError`
14+
15+
• **TVariables** = `unknown`
16+
17+
• **TContext** = `unknown`
18+
19+
## Defined in
20+
21+
[packages/svelte-query/src/types.ts:126](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L126)

‎docs/framework/svelte/reference/createqueries.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Function: createQueries()
2+
3+
```ts
4+
function createQueries<T, TCombinedResult>(
5+
__namedParameters,
6+
queryClient?,
7+
): Readable<TCombinedResult>
8+
```
9+
10+
## Type Parameters
11+
12+
• **T** _extends_ `any`[]
13+
14+
• **TCombinedResult** = `T` _extends_ [] ? [] : `T` _extends_ [`Head`] ? [`GetResults`\<`Head`\>] : `T` _extends_ [`Head`, `...Tail[]`] ? [`...Tail[]`] _extends_ [] ? [] : [`...Tail[]`] _extends_ [`Head`] ? [`GetResults`\<`Head`\>, `GetResults`\<`Head`\>] : [`...Tail[]`] _extends_ [`Head`, `...Tail[]`] ? [`...Tail[]`] _extends_ [] ? [] : [`...Tail[]`] _extends_ [`Head`] ? [`GetResults`\<`Head`\>, `GetResults`\<`Head`\>, `GetResults`\<`Head`\>] : [`...Tail[]`] _extends_ [`Head`, `...Tail[]`] ? [`...(...)[]`] _extends_ [] ? [] : ... _extends_ ... ? ... : ... : [`...(...)[]`] _extends_ ...[] ? ...[] : ...[] : [`...Tail[]`] _extends_ `QueryObserverOptionsForCreateQueries`\<`TQueryFnData`, `TError`, `TData`, `any`\>[] ? `QueryObserverResult`\<`unknown` _extends_ `TData` ? `TQueryFnData` : `TData`, `unknown` _extends_ `TError` ? `Error` : `TError`\>[] : `QueryObserverResult`[] : `T` _extends_ `QueryObserverOptionsForCreateQueries`\<`TQueryFnData`, `TError`, `TData`, `any`\>[] ? `QueryObserverResult`\<`unknown` _extends_ `TData` ? `TQueryFnData` : `TData`, `unknown` _extends_ `TError` ? `Error` : `TError`\>[] : `QueryObserverResult`[]
15+
16+
## Parameters
17+
18+
• **\_\_namedParameters**
19+
20+
• **\_\_namedParameters.combine?**
21+
22+
• **\_\_namedParameters.queries?**: [`StoreOrVal`](storeorval.md)\<[`...(T extends [] ? [] : T extends [Head] ? [GetOptions<Head>] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>[] ? QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>[] : QueryObserverOptionsForCreateQueries<unknown, Error, unknown, QueryKey>[])[]`]\>
23+
24+
• **queryClient?**: `QueryClient`
25+
26+
## Returns
27+
28+
`Readable`\<`TCombinedResult`\>
29+
30+
## Defined in
31+
32+
[packages/svelte-query/src/createQueries.ts:186](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQueries.ts#L186)

0 commit comments

Comments
 (0)