Skip to content

Commit d02e610

Browse files
lachlancollinslachlancollins
authored
docs(typedoc): Add frontmatter (#7753)
* docs(typedoc): Add frontmatter * Update knip.json
1 parent 13817e9 commit d02e610

Some content is hidden

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

42 files changed

+254
-38
lines changed

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: CreateBaseMutationResult
3+
title: CreateBaseMutationResult
4+
---
5+
16
# Type Alias: CreateBaseMutationResult\<TData, TError, TVariables, TContext\>
27

38
```ts
@@ -24,4 +29,4 @@ mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>
2429

2530
## Defined in
2631

27-
[packages/svelte-query/src/types.ts:113](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L113)
32+
[packages/svelte-query/src/types.ts:113](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L113)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: CreateBaseQueryOptions
3+
title: CreateBaseQueryOptions
4+
---
5+
16
# Type Alias: CreateBaseQueryOptions\<TQueryFnData, TError, TData, TQueryData, TQueryKey\>
27

38
```ts
@@ -20,4 +25,4 @@ Options for createBaseQuery
2025

2126
## Defined in
2227

23-
[packages/svelte-query/src/types.ts:23](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L23)
28+
[packages/svelte-query/src/types.ts:23](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L23)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: CreateBaseQueryResult
3+
title: CreateBaseQueryResult
4+
---
5+
16
# Type Alias: CreateBaseQueryResult\<TData, TError\>
27

38
```ts
@@ -14,4 +19,4 @@ Result from createBaseQuery
1419

1520
## Defined in
1621

17-
[packages/svelte-query/src/types.ts:32](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L32)
22+
[packages/svelte-query/src/types.ts:32](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L32)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: createInfiniteQuery
3+
title: createInfiniteQuery
4+
---
5+
16
# Function: createInfiniteQuery()
27

38
```ts
@@ -34,4 +39,4 @@ function createInfiniteQuery<
3439

3540
## Defined in
3641

37-
[packages/svelte-query/src/createInfiniteQuery.ts:16](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createInfiniteQuery.ts#L16)
42+
[packages/svelte-query/src/createInfiniteQuery.ts:16](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createInfiniteQuery.ts#L16)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: CreateInfiniteQueryOptions
3+
title: CreateInfiniteQueryOptions
4+
---
5+
16
# Type Alias: CreateInfiniteQueryOptions\<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam\>
27

38
```ts
@@ -22,4 +27,4 @@ Options for createInfiniteQuery
2227

2328
## Defined in
2429

25-
[packages/svelte-query/src/types.ts:52](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L52)
30+
[packages/svelte-query/src/types.ts:52](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L52)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: CreateInfiniteQueryResult
3+
title: CreateInfiniteQueryResult
4+
---
5+
16
# Type Alias: CreateInfiniteQueryResult\<TData, TError\>
27

38
```ts
@@ -14,4 +19,4 @@ Result from createInfiniteQuery
1419

1520
## Defined in
1621

17-
[packages/svelte-query/src/types.ts:69](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L69)
22+
[packages/svelte-query/src/types.ts:69](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L69)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: CreateMutateAsyncFunction
3+
title: CreateMutateAsyncFunction
4+
---
5+
16
# Type Alias: CreateMutateAsyncFunction\<TData, TError, TVariables, TContext\>
27

38
```ts
@@ -16,4 +21,4 @@ type CreateMutateAsyncFunction<TData, TError, TVariables, TContext>: MutateFunct
1621

1722
## Defined in
1823

19-
[packages/svelte-query/src/types.ts:106](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L106)
24+
[packages/svelte-query/src/types.ts:106](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L106)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: CreateMutateFunction
3+
title: CreateMutateFunction
4+
---
5+
16
# Type Alias: CreateMutateFunction()\<TData, TError, TVariables, TContext\>
27

38
```ts
@@ -24,4 +29,4 @@ type CreateMutateFunction<TData, TError, TVariables, TContext>: (...args) => voi
2429

2530
## Defined in
2631

27-
[packages/svelte-query/src/types.ts:97](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L97)
32+
[packages/svelte-query/src/types.ts:97](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L97)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: createMutation
3+
title: createMutation
4+
---
5+
16
# Function: createMutation()
27

38
```ts
@@ -29,4 +34,4 @@ function createMutation<TData, TError, TVariables, TContext>(
2934

3035
## Defined in
3136

32-
[packages/svelte-query/src/createMutation.ts:13](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createMutation.ts#L13)
37+
[packages/svelte-query/src/createMutation.ts:13](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createMutation.ts#L13)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: CreateMutationOptions
3+
title: CreateMutationOptions
4+
---
5+
16
# Type Alias: CreateMutationOptions\<TData, TError, TVariables, TContext\>
27

38
```ts
@@ -18,4 +23,4 @@ Options for createMutation
1823

1924
## Defined in
2025

21-
[packages/svelte-query/src/types.ts:87](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L87)
26+
[packages/svelte-query/src/types.ts:87](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L87)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: CreateMutationResult
3+
title: CreateMutationResult
4+
---
5+
16
# Type Alias: CreateMutationResult\<TData, TError, TVariables, TContext\>
27

38
```ts
@@ -18,4 +23,4 @@ Result from createMutation
1823

1924
## Defined in
2025

21-
[packages/svelte-query/src/types.ts:126](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L126)
26+
[packages/svelte-query/src/types.ts:126](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L126)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: createQueries
3+
title: createQueries
4+
---
5+
16
# Function: createQueries()
27

38
```ts
@@ -29,4 +34,4 @@ function createQueries<T, TCombinedResult>(
2934

3035
## Defined in
3136

32-
[packages/svelte-query/src/createQueries.ts:186](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQueries.ts#L186)
37+
[packages/svelte-query/src/createQueries.ts:186](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQueries.ts#L186)

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

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: createQuery
3+
title: createQuery
4+
---
5+
16
# Function: createQuery()
27

38
## createQuery(options, queryClient)
@@ -31,7 +36,7 @@ function createQuery<TQueryFnData, TError, TData, TQueryKey>(
3136

3237
### Defined in
3338

34-
[packages/svelte-query/src/createQuery.ts:15](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQuery.ts#L15)
39+
[packages/svelte-query/src/createQuery.ts:15](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQuery.ts#L15)
3540

3641
## createQuery(options, queryClient)
3742

@@ -64,4 +69,4 @@ function createQuery<TQueryFnData, TError, TData, TQueryKey>(
6469

6570
### Defined in
6671

67-
[packages/svelte-query/src/createQuery.ts:27](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQuery.ts#L27)
72+
[packages/svelte-query/src/createQuery.ts:27](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQuery.ts#L27)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: CreateQueryOptions
3+
title: CreateQueryOptions
4+
---
5+
16
# Type Alias: CreateQueryOptions\<TQueryFnData, TError, TData, TQueryKey\>
27

38
```ts
@@ -18,4 +23,4 @@ Options for createQuery
1823

1924
## Defined in
2025

21-
[packages/svelte-query/src/types.ts:38](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L38)
26+
[packages/svelte-query/src/types.ts:38](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L38)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: CreateQueryResult
3+
title: CreateQueryResult
4+
---
5+
16
# Type Alias: CreateQueryResult\<TData, TError\>
27

38
```ts
@@ -14,4 +19,4 @@ Result from createQuery
1419

1520
## Defined in
1621

17-
[packages/svelte-query/src/types.ts:46](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L46)
22+
[packages/svelte-query/src/types.ts:46](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L46)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: DefinedCreateBaseQueryResult
3+
title: DefinedCreateBaseQueryResult
4+
---
5+
16
# Type Alias: DefinedCreateBaseQueryResult\<TData, TError\>
27

38
```ts
@@ -14,4 +19,4 @@ Options for createBaseQuery with initialData
1419

1520
## Defined in
1621

17-
[packages/svelte-query/src/types.ts:75](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L75)
22+
[packages/svelte-query/src/types.ts:75](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L75)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: DefinedCreateQueryResult
3+
title: DefinedCreateQueryResult
4+
---
5+
16
# Type Alias: DefinedCreateQueryResult\<TData, TError\>
27

38
```ts
@@ -14,4 +19,4 @@ Options for createQuery with initialData
1419

1520
## Defined in
1621

17-
[packages/svelte-query/src/types.ts:81](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L81)
22+
[packages/svelte-query/src/types.ts:81](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L81)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: DefinedInitialDataOptions
3+
title: DefinedInitialDataOptions
4+
---
5+
16
# Type Alias: DefinedInitialDataOptions\<TQueryFnData, TError, TData, TQueryKey\>
27

38
```ts
@@ -24,4 +29,4 @@ initialData: NonUndefinedGuard<TQueryFnData> | () => NonUndefinedGuard<TQueryFnD
2429

2530
## Defined in
2631

27-
[packages/svelte-query/src/queryOptions.ts:15](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/queryOptions.ts#L15)
32+
[packages/svelte-query/src/queryOptions.ts:15](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/queryOptions.ts#L15)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: getIsRestoringContext
3+
title: getIsRestoringContext
4+
---
5+
16
# Function: getIsRestoringContext()
27

38
```ts
@@ -12,4 +17,4 @@ Retrieves a `isRestoring` from Svelte's context
1217

1318
## Defined in
1419

15-
[packages/svelte-query/src/context.ts:28](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/context.ts#L28)
20+
[packages/svelte-query/src/context.ts:28](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/context.ts#L28)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: getQueryClientContext
3+
title: getQueryClientContext
4+
---
5+
16
# Function: getQueryClientContext()
27

38
```ts
@@ -12,4 +17,4 @@ Retrieves a Client from Svelte's context
1217

1318
## Defined in
1419

15-
[packages/svelte-query/src/context.ts:9](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/context.ts#L9)
20+
[packages/svelte-query/src/context.ts:9](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/context.ts#L9)

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

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: HydrationBoundary
3+
title: HydrationBoundary
4+
---
5+
16
# Class: HydrationBoundary\<Props, Events, Slots\>
27

38
Base class for Svelte components with some minor dev-enhancements. Used when dev=true.

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

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: '@tanstack/svelte-query'
3+
title: '@tanstack/svelte-query'
4+
---
5+
16
# @tanstack/svelte-query
27

38
## References

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: infiniteQueryOptions
3+
title: infiniteQueryOptions
4+
---
5+
16
# Function: infiniteQueryOptions()
27

38
```ts
@@ -41,4 +46,4 @@ function infiniteQueryOptions<
4146

4247
## Defined in
4348

44-
[packages/svelte-query/src/infiniteQueryOptions.ts:4](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/infiniteQueryOptions.ts#L4)
49+
[packages/svelte-query/src/infiniteQueryOptions.ts:4](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/infiniteQueryOptions.ts#L4)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: MutationStateOptions
3+
title: MutationStateOptions
4+
---
5+
16
# Type Alias: MutationStateOptions\<TResult\>
27

38
```ts
@@ -34,4 +39,4 @@ optional select: (mutation) => TResult;
3439

3540
## Defined in
3641

37-
[packages/svelte-query/src/types.ts:140](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L140)
42+
[packages/svelte-query/src/types.ts:140](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L140)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: QueriesOptions
3+
title: QueriesOptions
4+
---
5+
16
# Type Alias: QueriesOptions\<T, TResult, TDepth\>
27

38
```ts
@@ -16,4 +21,4 @@ QueriesOptions reducer recursively unwraps function arguments to infer/enforce t
1621

1722
## Defined in
1823

19-
[packages/svelte-query/src/createQueries.ts:110](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQueries.ts#L110)
24+
[packages/svelte-query/src/createQueries.ts:110](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQueries.ts#L110)

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

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
id: QueriesResults
3+
title: QueriesResults
4+
---
5+
16
# Type Alias: QueriesResults\<T, TResult, TDepth\>
27

38
```ts
@@ -16,4 +21,4 @@ QueriesResults reducer recursively maps type param to results
1621

1722
## Defined in
1823

19-
[packages/svelte-query/src/createQueries.ts:152](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQueries.ts#L152)
24+
[packages/svelte-query/src/createQueries.ts:152](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQueries.ts#L152)

0 commit comments

Comments
 (0)