docs(typedoc): Add frontmatter (#7753)

* docs(typedoc): Add frontmatter * Update knip.json
TanStack · Jul 18, 2024 · d02e610 · d02e610
1 parent 13817e9
commit d02e610
Show file tree

Hide file tree

Showing 42 changed files with 254 additions and 38 deletions.
diff --git a/docs/framework/svelte/reference/createbasemutationresult.md b/docs/framework/svelte/reference/createbasemutationresult.md
@@ -1,3 +1,8 @@
+---
+id: CreateBaseMutationResult
+title: CreateBaseMutationResult
+---
+
 # Type Alias: CreateBaseMutationResult\<TData, TError, TVariables, TContext\>
 
 ```ts
@@ -24,4 +29,4 @@ mutateAsync: CreateMutateAsyncFunction<TData, TError, TVariables, TContext>
 
 ## Defined in
 
-[packages/svelte-query/src/types.ts:113](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L113)
+[packages/svelte-query/src/types.ts:113](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L113)
diff --git a/docs/framework/svelte/reference/createbasequeryoptions.md b/docs/framework/svelte/reference/createbasequeryoptions.md
@@ -1,3 +1,8 @@
+---
+id: CreateBaseQueryOptions
+title: CreateBaseQueryOptions
+---
+
 # Type Alias: CreateBaseQueryOptions\<TQueryFnData, TError, TData, TQueryData, TQueryKey\>
 
 ```ts
@@ -20,4 +25,4 @@ Options for createBaseQuery
 
 ## Defined in
 
-[packages/svelte-query/src/types.ts:23](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L23)
+[packages/svelte-query/src/types.ts:23](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L23)
diff --git a/docs/framework/svelte/reference/createbasequeryresult.md b/docs/framework/svelte/reference/createbasequeryresult.md
@@ -1,3 +1,8 @@
+---
+id: CreateBaseQueryResult
+title: CreateBaseQueryResult
+---
+
 # Type Alias: CreateBaseQueryResult\<TData, TError\>
 
 ```ts
@@ -14,4 +19,4 @@ Result from createBaseQuery
 
 ## Defined in
 
-[packages/svelte-query/src/types.ts:32](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L32)
+[packages/svelte-query/src/types.ts:32](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L32)
diff --git a/docs/framework/svelte/reference/createinfinitequery.md b/docs/framework/svelte/reference/createinfinitequery.md
@@ -1,3 +1,8 @@
+---
+id: createInfiniteQuery
+title: createInfiniteQuery
+---
+
 # Function: createInfiniteQuery()
 
 ```ts
@@ -34,4 +39,4 @@ function createInfiniteQuery<
 
 ## Defined in
 
-[packages/svelte-query/src/createInfiniteQuery.ts:16](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createInfiniteQuery.ts#L16)
+[packages/svelte-query/src/createInfiniteQuery.ts:16](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createInfiniteQuery.ts#L16)
diff --git a/docs/framework/svelte/reference/createinfinitequeryoptions.md b/docs/framework/svelte/reference/createinfinitequeryoptions.md
@@ -1,3 +1,8 @@
+---
+id: CreateInfiniteQueryOptions
+title: CreateInfiniteQueryOptions
+---
+
 # Type Alias: CreateInfiniteQueryOptions\<TQueryFnData, TError, TData, TQueryData, TQueryKey, TPageParam\>
 
 ```ts
@@ -22,4 +27,4 @@ Options for createInfiniteQuery
 
 ## Defined in
 
-[packages/svelte-query/src/types.ts:52](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L52)
+[packages/svelte-query/src/types.ts:52](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L52)
diff --git a/docs/framework/svelte/reference/createinfinitequeryresult.md b/docs/framework/svelte/reference/createinfinitequeryresult.md
@@ -1,3 +1,8 @@
+---
+id: CreateInfiniteQueryResult
+title: CreateInfiniteQueryResult
+---
+
 # Type Alias: CreateInfiniteQueryResult\<TData, TError\>
 
 ```ts
@@ -14,4 +19,4 @@ Result from createInfiniteQuery
 
 ## Defined in
 
-[packages/svelte-query/src/types.ts:69](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L69)
+[packages/svelte-query/src/types.ts:69](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L69)
diff --git a/docs/framework/svelte/reference/createmutateasyncfunction.md b/docs/framework/svelte/reference/createmutateasyncfunction.md
@@ -1,3 +1,8 @@
+---
+id: CreateMutateAsyncFunction
+title: CreateMutateAsyncFunction
+---
+
 # Type Alias: CreateMutateAsyncFunction\<TData, TError, TVariables, TContext\>
 
 ```ts
@@ -16,4 +21,4 @@ type CreateMutateAsyncFunction<TData, TError, TVariables, TContext>: MutateFunct
 
 ## Defined in
 
-[packages/svelte-query/src/types.ts:106](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L106)
+[packages/svelte-query/src/types.ts:106](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L106)
diff --git a/docs/framework/svelte/reference/createmutatefunction.md b/docs/framework/svelte/reference/createmutatefunction.md
@@ -1,3 +1,8 @@
+---
+id: CreateMutateFunction
+title: CreateMutateFunction
+---
+
 # Type Alias: CreateMutateFunction()\<TData, TError, TVariables, TContext\>
 
 ```ts
@@ -24,4 +29,4 @@ type CreateMutateFunction<TData, TError, TVariables, TContext>: (...args) => voi
 
 ## Defined in
 
-[packages/svelte-query/src/types.ts:97](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L97)
+[packages/svelte-query/src/types.ts:97](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L97)
diff --git a/docs/framework/svelte/reference/createmutation.md b/docs/framework/svelte/reference/createmutation.md
@@ -1,3 +1,8 @@
+---
+id: createMutation
+title: createMutation
+---
+
 # Function: createMutation()
 
 ```ts
@@ -29,4 +34,4 @@ function createMutation<TData, TError, TVariables, TContext>(
 
 ## Defined in
 
-[packages/svelte-query/src/createMutation.ts:13](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createMutation.ts#L13)
+[packages/svelte-query/src/createMutation.ts:13](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createMutation.ts#L13)
diff --git a/docs/framework/svelte/reference/createmutationoptions.md b/docs/framework/svelte/reference/createmutationoptions.md
@@ -1,3 +1,8 @@
+---
+id: CreateMutationOptions
+title: CreateMutationOptions
+---
+
 # Type Alias: CreateMutationOptions\<TData, TError, TVariables, TContext\>
 
 ```ts
@@ -18,4 +23,4 @@ Options for createMutation
 
 ## Defined in
 
-[packages/svelte-query/src/types.ts:87](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L87)
+[packages/svelte-query/src/types.ts:87](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L87)
diff --git a/docs/framework/svelte/reference/createmutationresult.md b/docs/framework/svelte/reference/createmutationresult.md
@@ -1,3 +1,8 @@
+---
+id: CreateMutationResult
+title: CreateMutationResult
+---
+
 # Type Alias: CreateMutationResult\<TData, TError, TVariables, TContext\>
 
 ```ts
@@ -18,4 +23,4 @@ Result from createMutation
 
 ## Defined in
 
-[packages/svelte-query/src/types.ts:126](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L126)
+[packages/svelte-query/src/types.ts:126](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L126)
diff --git a/docs/framework/svelte/reference/createqueries.md b/docs/framework/svelte/reference/createqueries.md
@@ -1,3 +1,8 @@
+---
+id: createQueries
+title: createQueries
+---
+
 # Function: createQueries()
 
 ```ts
@@ -29,4 +34,4 @@ function createQueries<T, TCombinedResult>(
 
 ## Defined in
 
-[packages/svelte-query/src/createQueries.ts:186](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQueries.ts#L186)
+[packages/svelte-query/src/createQueries.ts:186](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQueries.ts#L186)
diff --git a/docs/framework/svelte/reference/createquery.md b/docs/framework/svelte/reference/createquery.md
@@ -1,3 +1,8 @@
+---
+id: createQuery
+title: createQuery
+---
+
 # Function: createQuery()
 
 ## createQuery(options, queryClient)
@@ -31,7 +36,7 @@ function createQuery<TQueryFnData, TError, TData, TQueryKey>(
 
 ### Defined in
 
-[packages/svelte-query/src/createQuery.ts:15](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQuery.ts#L15)
+[packages/svelte-query/src/createQuery.ts:15](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQuery.ts#L15)
 
 ## createQuery(options, queryClient)
 
@@ -64,4 +69,4 @@ function createQuery<TQueryFnData, TError, TData, TQueryKey>(
 
 ### Defined in
 
-[packages/svelte-query/src/createQuery.ts:27](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQuery.ts#L27)
+[packages/svelte-query/src/createQuery.ts:27](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQuery.ts#L27)
diff --git a/docs/framework/svelte/reference/createqueryoptions.md b/docs/framework/svelte/reference/createqueryoptions.md
@@ -1,3 +1,8 @@
+---
+id: CreateQueryOptions
+title: CreateQueryOptions
+---
+
 # Type Alias: CreateQueryOptions\<TQueryFnData, TError, TData, TQueryKey\>
 
 ```ts
@@ -18,4 +23,4 @@ Options for createQuery
 
 ## Defined in
 
-[packages/svelte-query/src/types.ts:38](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L38)
+[packages/svelte-query/src/types.ts:38](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L38)
diff --git a/docs/framework/svelte/reference/createqueryresult.md b/docs/framework/svelte/reference/createqueryresult.md
@@ -1,3 +1,8 @@
+---
+id: CreateQueryResult
+title: CreateQueryResult
+---
+
 # Type Alias: CreateQueryResult\<TData, TError\>
 
 ```ts
@@ -14,4 +19,4 @@ Result from createQuery
 
 ## Defined in
 
-[packages/svelte-query/src/types.ts:46](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L46)
+[packages/svelte-query/src/types.ts:46](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L46)
diff --git a/docs/framework/svelte/reference/definedcreatebasequeryresult.md b/docs/framework/svelte/reference/definedcreatebasequeryresult.md
@@ -1,3 +1,8 @@
+---
+id: DefinedCreateBaseQueryResult
+title: DefinedCreateBaseQueryResult
+---
+
 # Type Alias: DefinedCreateBaseQueryResult\<TData, TError\>
 
 ```ts
@@ -14,4 +19,4 @@ Options for createBaseQuery with initialData
 
 ## Defined in
 
-[packages/svelte-query/src/types.ts:75](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L75)
+[packages/svelte-query/src/types.ts:75](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L75)
diff --git a/docs/framework/svelte/reference/definedcreatequeryresult.md b/docs/framework/svelte/reference/definedcreatequeryresult.md
@@ -1,3 +1,8 @@
+---
+id: DefinedCreateQueryResult
+title: DefinedCreateQueryResult
+---
+
 # Type Alias: DefinedCreateQueryResult\<TData, TError\>
 
 ```ts
@@ -14,4 +19,4 @@ Options for createQuery with initialData
 
 ## Defined in
 
-[packages/svelte-query/src/types.ts:81](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L81)
+[packages/svelte-query/src/types.ts:81](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L81)
diff --git a/docs/framework/svelte/reference/definedinitialdataoptions.md b/docs/framework/svelte/reference/definedinitialdataoptions.md
@@ -1,3 +1,8 @@
+---
+id: DefinedInitialDataOptions
+title: DefinedInitialDataOptions
+---
+
 # Type Alias: DefinedInitialDataOptions\<TQueryFnData, TError, TData, TQueryKey\>
 
 ```ts
@@ -24,4 +29,4 @@ initialData: NonUndefinedGuard<TQueryFnData> | () => NonUndefinedGuard<TQueryFnD
 
 ## Defined in
 
-[packages/svelte-query/src/queryOptions.ts:15](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/queryOptions.ts#L15)
+[packages/svelte-query/src/queryOptions.ts:15](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/queryOptions.ts#L15)
diff --git a/docs/framework/svelte/reference/getisrestoringcontext.md b/docs/framework/svelte/reference/getisrestoringcontext.md
@@ -1,3 +1,8 @@
+---
+id: getIsRestoringContext
+title: getIsRestoringContext
+---
+
 # Function: getIsRestoringContext()
 
 ```ts
@@ -12,4 +17,4 @@ Retrieves a `isRestoring` from Svelte's context
 
 ## Defined in
 
-[packages/svelte-query/src/context.ts:28](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/context.ts#L28)
+[packages/svelte-query/src/context.ts:28](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/context.ts#L28)
diff --git a/docs/framework/svelte/reference/getqueryclientcontext.md b/docs/framework/svelte/reference/getqueryclientcontext.md
@@ -1,3 +1,8 @@
+---
+id: getQueryClientContext
+title: getQueryClientContext
+---
+
 # Function: getQueryClientContext()
 
 ```ts
@@ -12,4 +17,4 @@ Retrieves a Client from Svelte's context
 
 ## Defined in
 
-[packages/svelte-query/src/context.ts:9](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/context.ts#L9)
+[packages/svelte-query/src/context.ts:9](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/context.ts#L9)
diff --git a/docs/framework/svelte/reference/hydrationboundary.md b/docs/framework/svelte/reference/hydrationboundary.md
@@ -1,3 +1,8 @@
+---
+id: HydrationBoundary
+title: HydrationBoundary
+---
+
 # Class: HydrationBoundary\<Props, Events, Slots\>
 
 Base class for Svelte components with some minor dev-enhancements. Used when dev=true.

diff --git a/docs/framework/svelte/reference/index.md b/docs/framework/svelte/reference/index.md
@@ -1,3 +1,8 @@
+---
+id: '@tanstack/svelte-query'
+title: '@tanstack/svelte-query'
+---
+
 # @tanstack/svelte-query
 
 ## References

diff --git a/docs/framework/svelte/reference/infinitequeryoptions.md b/docs/framework/svelte/reference/infinitequeryoptions.md
@@ -1,3 +1,8 @@
+---
+id: infiniteQueryOptions
+title: infiniteQueryOptions
+---
+
 # Function: infiniteQueryOptions()
 
 ```ts
@@ -41,4 +46,4 @@ function infiniteQueryOptions<
 
 ## Defined in
 
-[packages/svelte-query/src/infiniteQueryOptions.ts:4](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/infiniteQueryOptions.ts#L4)
+[packages/svelte-query/src/infiniteQueryOptions.ts:4](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/infiniteQueryOptions.ts#L4)
diff --git a/docs/framework/svelte/reference/mutationstateoptions.md b/docs/framework/svelte/reference/mutationstateoptions.md
@@ -1,3 +1,8 @@
+---
+id: MutationStateOptions
+title: MutationStateOptions
+---
+
 # Type Alias: MutationStateOptions\<TResult\>
 
 ```ts
@@ -34,4 +39,4 @@ optional select: (mutation) => TResult;
 
 ## Defined in
 
-[packages/svelte-query/src/types.ts:140](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L140)
+[packages/svelte-query/src/types.ts:140](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L140)
diff --git a/docs/framework/svelte/reference/queriesoptions.md b/docs/framework/svelte/reference/queriesoptions.md
@@ -1,3 +1,8 @@
+---
+id: QueriesOptions
+title: QueriesOptions
+---
+
 # Type Alias: QueriesOptions\<T, TResult, TDepth\>
 
 ```ts
@@ -16,4 +21,4 @@ QueriesOptions reducer recursively unwraps function arguments to infer/enforce t
 
 ## Defined in
 
-[packages/svelte-query/src/createQueries.ts:110](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQueries.ts#L110)
+[packages/svelte-query/src/createQueries.ts:110](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQueries.ts#L110)
diff --git a/docs/framework/svelte/reference/queriesresults.md b/docs/framework/svelte/reference/queriesresults.md
@@ -1,3 +1,8 @@
+---
+id: QueriesResults
+title: QueriesResults
+---
+
 # Type Alias: QueriesResults\<T, TResult, TDepth\>
 
 ```ts
@@ -16,4 +21,4 @@ QueriesResults reducer recursively maps type param to results
 
 ## Defined in
 
-[packages/svelte-query/src/createQueries.ts:152](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/createQueries.ts#L152)
+[packages/svelte-query/src/createQueries.ts:152](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/createQueries.ts#L152)