diff --git a/docs/framework/svelte/reference/createbasemutationresult.md b/docs/framework/svelte/reference/createbasemutationresult.md index 5b86e9d9ad..41b60c4c3c 100644 --- 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\ ```ts @@ -24,4 +29,4 @@ mutateAsync: CreateMutateAsyncFunction ## 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 index 25ef1688bf..d379b92ba8 100644 --- 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\ ```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 index 3b3f6ed07d..ac031d191e 100644 --- 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\ ```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 index 7f7b1b96af..f2490be89b 100644 --- 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 index 4dfd03cd0c..9859a4fd03 100644 --- 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\ ```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 index 6c3d3fec42..3bc5437a76 100644 --- 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\ ```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 index b1dabd4bcc..86f9503dfd 100644 --- 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\ ```ts @@ -16,4 +21,4 @@ type CreateMutateAsyncFunction: 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 index 4cc1585008..c392552350 100644 --- 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()\ ```ts @@ -24,4 +29,4 @@ type CreateMutateFunction: (...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 index 674f454b72..0c3ed37dd6 100644 --- 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( ## 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 index 0a1b768416..9a82d65f98 100644 --- 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\ ```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 index 42ef7978f8..678f576921 100644 --- 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\ ```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 index 90bdafef57..4514bd2611 100644 --- 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( ## 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 index 3f6fdf6e27..33dd11784c 100644 --- 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( ### 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( ### 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 index 78e50977a0..0763b4c261 100644 --- 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\ ```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 index e3ab8e7f9c..0d42d7f67e 100644 --- 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\ ```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 index 1c409ed03b..fab7a23c4e 100644 --- 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\ ```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 index 31ee691785..65cbf736c7 100644 --- 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\ ```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 index 53e75d6d19..b4f78f6b58 100644 --- 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\ ```ts @@ -24,4 +29,4 @@ initialData: NonUndefinedGuard | () => NonUndefinedGuard 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 index 4ca9528529..10cd8ef7a9 100644 --- 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 index 1a5bfdf8d9..234c7bec56 100644 --- 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 index de4b70a68d..669ab69090 100644 --- 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\ ```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 index d6db042c9e..b726b691bf 100644 --- 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\ ```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 index f654f008ec..9defc9c2b8 100644 --- 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\ ```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) diff --git a/docs/framework/svelte/reference/queryoptions.md b/docs/framework/svelte/reference/queryoptions.md index 2e886c20d0..c3928af5c5 100644 --- a/docs/framework/svelte/reference/queryoptions.md +++ b/docs/framework/svelte/reference/queryoptions.md @@ -1,3 +1,8 @@ +--- +id: queryOptions +title: queryOptions +--- + # Function: queryOptions() ## queryOptions(options) @@ -28,7 +33,7 @@ function queryOptions( ### Defined in -[packages/svelte-query/src/queryOptions.ts:26](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/queryOptions.ts#L26) +[packages/svelte-query/src/queryOptions.ts:26](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/queryOptions.ts#L26) ## queryOptions(options) @@ -58,4 +63,4 @@ function queryOptions( ### Defined in -[packages/svelte-query/src/queryOptions.ts:37](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/queryOptions.ts#L37) +[packages/svelte-query/src/queryOptions.ts:37](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/queryOptions.ts#L37) diff --git a/docs/framework/svelte/reference/setisrestoringcontext.md b/docs/framework/svelte/reference/setisrestoringcontext.md index e91d799aa4..1f147aadd4 100644 --- a/docs/framework/svelte/reference/setisrestoringcontext.md +++ b/docs/framework/svelte/reference/setisrestoringcontext.md @@ -1,3 +1,8 @@ +--- +id: setIsRestoringContext +title: setIsRestoringContext +--- + # Function: setIsRestoringContext() ```ts @@ -16,4 +21,4 @@ Sets a `isRestoring` on Svelte's context ## Defined in -[packages/svelte-query/src/context.ts:40](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/context.ts#L40) +[packages/svelte-query/src/context.ts:40](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/context.ts#L40) diff --git a/docs/framework/svelte/reference/setqueryclientcontext.md b/docs/framework/svelte/reference/setqueryclientcontext.md index 19540cf8a4..eb228e9327 100644 --- a/docs/framework/svelte/reference/setqueryclientcontext.md +++ b/docs/framework/svelte/reference/setqueryclientcontext.md @@ -1,3 +1,8 @@ +--- +id: setQueryClientContext +title: setQueryClientContext +--- + # Function: setQueryClientContext() ```ts @@ -16,4 +21,4 @@ Sets a QueryClient on Svelte's context ## Defined in -[packages/svelte-query/src/context.ts:21](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/context.ts#L21) +[packages/svelte-query/src/context.ts:21](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/context.ts#L21) diff --git a/docs/framework/svelte/reference/storeorval.md b/docs/framework/svelte/reference/storeorval.md index 748729e4e3..cf7bb05eba 100644 --- a/docs/framework/svelte/reference/storeorval.md +++ b/docs/framework/svelte/reference/storeorval.md @@ -1,3 +1,8 @@ +--- +id: StoreOrVal +title: StoreOrVal +--- + # Type Alias: StoreOrVal\ ```ts @@ -12,4 +17,4 @@ Allows a type to be either the base object or a store of that object ## Defined in -[packages/svelte-query/src/types.ts:20](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/types.ts#L20) +[packages/svelte-query/src/types.ts:20](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/types.ts#L20) diff --git a/docs/framework/svelte/reference/undefinedinitialdataoptions.md b/docs/framework/svelte/reference/undefinedinitialdataoptions.md index f9d899ba49..0686485922 100644 --- a/docs/framework/svelte/reference/undefinedinitialdataoptions.md +++ b/docs/framework/svelte/reference/undefinedinitialdataoptions.md @@ -1,3 +1,8 @@ +--- +id: UndefinedInitialDataOptions +title: UndefinedInitialDataOptions +--- + # Type Alias: UndefinedInitialDataOptions\ ```ts @@ -24,4 +29,4 @@ optional initialData: undefined; ## Defined in -[packages/svelte-query/src/queryOptions.ts:4](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/queryOptions.ts#L4) +[packages/svelte-query/src/queryOptions.ts:4](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/queryOptions.ts#L4) diff --git a/docs/framework/svelte/reference/usehydrate.md b/docs/framework/svelte/reference/usehydrate.md index 60b4773c64..6a99984929 100644 --- a/docs/framework/svelte/reference/usehydrate.md +++ b/docs/framework/svelte/reference/usehydrate.md @@ -1,3 +1,8 @@ +--- +id: useHydrate +title: useHydrate +--- + # Function: useHydrate() ```ts @@ -18,4 +23,4 @@ function useHydrate(state?, options?, queryClient?): void ## Defined in -[packages/svelte-query/src/useHydrate.ts:8](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/useHydrate.ts#L8) +[packages/svelte-query/src/useHydrate.ts:8](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/useHydrate.ts#L8) diff --git a/docs/framework/svelte/reference/useisfetching.md b/docs/framework/svelte/reference/useisfetching.md index 5cdc279231..eccc280fcf 100644 --- a/docs/framework/svelte/reference/useisfetching.md +++ b/docs/framework/svelte/reference/useisfetching.md @@ -1,3 +1,8 @@ +--- +id: useIsFetching +title: useIsFetching +--- + # Function: useIsFetching() ```ts @@ -16,4 +21,4 @@ function useIsFetching(filters?, queryClient?): Readable ## Defined in -[packages/svelte-query/src/useIsFetching.ts:10](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/useIsFetching.ts#L10) +[packages/svelte-query/src/useIsFetching.ts:10](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/useIsFetching.ts#L10) diff --git a/docs/framework/svelte/reference/useismutating.md b/docs/framework/svelte/reference/useismutating.md index 40d7322b4f..cdbbc8d61b 100644 --- a/docs/framework/svelte/reference/useismutating.md +++ b/docs/framework/svelte/reference/useismutating.md @@ -1,3 +1,8 @@ +--- +id: useIsMutating +title: useIsMutating +--- + # Function: useIsMutating() ```ts @@ -16,4 +21,4 @@ function useIsMutating(filters?, queryClient?): Readable ## Defined in -[packages/svelte-query/src/useIsMutating.ts:10](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/useIsMutating.ts#L10) +[packages/svelte-query/src/useIsMutating.ts:10](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/useIsMutating.ts#L10) diff --git a/docs/framework/svelte/reference/useisrestoring.md b/docs/framework/svelte/reference/useisrestoring.md index 378744217f..6866d84016 100644 --- a/docs/framework/svelte/reference/useisrestoring.md +++ b/docs/framework/svelte/reference/useisrestoring.md @@ -1,3 +1,8 @@ +--- +id: useIsRestoring +title: useIsRestoring +--- + # Function: useIsRestoring() ```ts @@ -10,4 +15,4 @@ function useIsRestoring(): Readable ## Defined in -[packages/svelte-query/src/useIsRestoring.ts:4](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/useIsRestoring.ts#L4) +[packages/svelte-query/src/useIsRestoring.ts:4](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/useIsRestoring.ts#L4) diff --git a/docs/framework/svelte/reference/usemutationstate.md b/docs/framework/svelte/reference/usemutationstate.md index 950ac06081..e05eeb1b02 100644 --- a/docs/framework/svelte/reference/usemutationstate.md +++ b/docs/framework/svelte/reference/usemutationstate.md @@ -1,3 +1,8 @@ +--- +id: useMutationState +title: useMutationState +--- + # Function: useMutationState() ```ts @@ -20,4 +25,4 @@ function useMutationState(options, queryClient?): Readable ## Defined in -[packages/svelte-query/src/useMutationState.ts:24](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/useMutationState.ts#L24) +[packages/svelte-query/src/useMutationState.ts:24](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/useMutationState.ts#L24) diff --git a/docs/framework/svelte/reference/usequeryclient.md b/docs/framework/svelte/reference/usequeryclient.md index 1f5105108d..dd4abc3bd7 100644 --- a/docs/framework/svelte/reference/usequeryclient.md +++ b/docs/framework/svelte/reference/usequeryclient.md @@ -1,3 +1,8 @@ +--- +id: useQueryClient +title: useQueryClient +--- + # Function: useQueryClient() ```ts @@ -14,4 +19,4 @@ function useQueryClient(queryClient?): QueryClient ## Defined in -[packages/svelte-query/src/useQueryClient.ts:4](https://github.com/TanStack/query/blob/81ca3332486f7b98502d4f5ea50588d88a80f59b/packages/svelte-query/src/useQueryClient.ts#L4) +[packages/svelte-query/src/useQueryClient.ts:4](https://github.com/TanStack/query/blob/13817e953743537ffb9aab4da174583055be4d81/packages/svelte-query/src/useQueryClient.ts#L4) diff --git a/knip.json b/knip.json index 7299499950..dd25eb7f0d 100644 --- a/knip.json +++ b/knip.json @@ -1,6 +1,7 @@ { "$schema": "https://unpkg.com/knip@5/schema.json", "ignore": [".pnpmfile.cjs", "scripts/typedoc-remove-prefix.js"], + "ignoreDependencies": ["typedoc-plugin-frontmatter"], "ignoreWorkspaces": ["examples/**", "integrations/**"], "workspaces": { "packages/query-codemods": { diff --git a/package.json b/package.json index 391ab769bd..e4fb4b459c 100644 --- a/package.json +++ b/package.json @@ -70,6 +70,7 @@ "solid-js": "^1.8.17", "tsup": "^8.0.2", "typedoc": "^0.26.4", + "typedoc-plugin-frontmatter": "^1.0.0", "typedoc-plugin-markdown": "^4.2.1", "typescript": "5.3.3", "typescript47": "npm:typescript@4.7", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 16b991a7be..7ab4317796 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -108,6 +108,9 @@ importers: typedoc: specifier: ^0.26.4 version: 0.26.4(typescript@5.3.3) + typedoc-plugin-frontmatter: + specifier: ^1.0.0 + version: 1.0.0(typedoc-plugin-markdown@4.2.1(typedoc@0.26.4(typescript@5.3.3))) typedoc-plugin-markdown: specifier: ^4.2.1 version: 4.2.1(typedoc@0.26.4(typescript@5.3.3)) @@ -16104,6 +16107,11 @@ packages: typedarray@0.0.6: resolution: {integrity: sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==} + typedoc-plugin-frontmatter@1.0.0: + resolution: {integrity: sha512-Mqn96+RjUjPUz/42H8MOp/8eOKjE5MVIgZRFDGmSI2YuggnMZSfh5MMpvd6ykjNTpq7gV5D2iwjqLt8nYRg9rg==} + peerDependencies: + typedoc-plugin-markdown: '>=4.0.0' + typedoc-plugin-markdown@4.2.1: resolution: {integrity: sha512-7hQt/1WaW/VI4+x3sxwcCGsEylP1E1GvF6OTTELK5sfTEp6AeK+83jkCOgZGp1pI2DiOammMYQMnxxOny9TKsQ==} engines: {node: '>= 18'} @@ -35173,6 +35181,11 @@ snapshots: typedarray@0.0.6: {} + typedoc-plugin-frontmatter@1.0.0(typedoc-plugin-markdown@4.2.1(typedoc@0.26.4(typescript@5.3.3))): + dependencies: + typedoc-plugin-markdown: 4.2.1(typedoc@0.26.4(typescript@5.3.3)) + yaml: 2.4.5 + typedoc-plugin-markdown@4.2.1(typedoc@0.26.4(typescript@5.3.3)): dependencies: typedoc: 0.26.4(typescript@5.3.3) diff --git a/scripts/reference-docs.js b/scripts/reference-docs.js index d797016f31..bbae3c9d5f 100644 --- a/scripts/reference-docs.js +++ b/scripts/reference-docs.js @@ -11,6 +11,7 @@ const __dirname = fileURLToPath(new URL('.', import.meta.url)) const options = { plugin: [ 'typedoc-plugin-markdown', + 'typedoc-plugin-frontmatter', resolve(__dirname, './typedoc-remove-prefix.js'), ], hideGenerator: true, diff --git a/scripts/typedoc-remove-prefix.js b/scripts/typedoc-remove-prefix.js index f9cfc8d763..14c5e2b670 100644 --- a/scripts/typedoc-remove-prefix.js +++ b/scripts/typedoc-remove-prefix.js @@ -1,9 +1,24 @@ -import { MarkdownRendererEvent } from 'typedoc-plugin-markdown' +import { + MarkdownPageEvent, + MarkdownRendererEvent, +} from 'typedoc-plugin-markdown' /** * @param {import("typedoc-plugin-markdown").MarkdownApplication} app */ export function load(app) { + // Add `id` and `title` to frontmatter + app.renderer.on( + MarkdownPageEvent.BEGIN, + /** @param {import('typedoc-plugin-markdown').MarkdownPageEvent} page */ + (page) => { + page.frontmatter = { + id: page.model.name, + title: page.model.name, + } + }, + ) + // Rename output files app.renderer.on( MarkdownRendererEvent.BEGIN, /**