From f35c90183e83946f71eadc866a4cb1c7e496d26f Mon Sep 17 00:00:00 2001 From: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com> Date: Tue, 14 Jan 2025 11:12:32 +1100 Subject: [PATCH 1/3] docs: re-generate typedoc --- .../functions/infinitequeryoptions.md | 28 ++-- .../functions/injectinfinitequery.md | 50 +++--- .../reference/functions/injectisfetching.md | 10 +- .../reference/functions/injectismutating.md | 10 +- .../reference/functions/injectmutation.md | 10 +- .../functions/injectmutationstate.md | 10 +- .../reference/functions/injectqueries.md | 16 +- .../reference/functions/injectquery.md | 42 +++-- .../reference/functions/injectqueryclient.md | 73 ++------- .../reference/functions/mutationoptions.md | 67 ++++++++ .../functions/provideangularquery.md | 42 ++--- .../reference/functions/providequeryclient.md | 28 +++- .../functions/providetanstackquery.md | 92 +++++++++++ .../reference/functions/queryoptions.md | 28 ++-- .../reference/functions/withdevtools.md | 49 ++++++ docs/framework/angular/reference/index.md | 12 ++ .../interfaces/basemutationnarrowing.md | 136 +++++++++++------ .../interfaces/basequerynarrowing.md | 18 ++- .../reference/interfaces/devtoolsoptions.md | 143 ++++++++++++++++++ .../interfaces/injectmutationstateoptions.md | 2 +- .../reference/interfaces/queryfeature.md | 36 +++++ .../type-aliases/createbasemutationresult.md | 10 +- .../type-aliases/createbasequeryresult.md | 8 +- .../type-aliases/createinfinitequeryresult.md | 6 +- .../type-aliases/createmutateasyncfunction.md | 5 +- .../type-aliases/createmutatefunction.md | 10 +- .../type-aliases/createmutationresult.md | 6 +- .../type-aliases/createqueryresult.md | 4 +- .../definedcreateinfinitequeryresult.md | 8 +- .../type-aliases/definedcreatequeryresult.md | 12 +- .../definedinitialdatainfiniteoptions.md | 22 ++- .../type-aliases/definedinitialdataoptions.md | 9 +- .../type-aliases/developertoolsfeature.md | 21 +++ .../type-aliases/nonundefinedguard.md | 4 +- .../reference/type-aliases/queriesoptions.md | 30 +++- .../reference/type-aliases/queriesresults.md | 26 +++- .../type-aliases/queryfeaturekind.md | 14 ++ .../reference/type-aliases/queryfeatures.md | 23 +++ .../undefinedinitialdatainfiniteoptions.md | 18 ++- .../undefinedinitialdataoptions.md | 7 +- .../reference/variables/queryfeatures.md | 14 ++ .../reference/classes/hydrationboundary.md | 38 +++-- .../functions/createinfinitequery.md | 12 +- .../reference/functions/createmutation.md | 10 +- .../reference/functions/createqueries.md | 16 +- .../svelte/reference/functions/createquery.md | 42 +++-- .../functions/getisrestoringcontext.md | 2 +- .../functions/getqueryclientcontext.md | 2 +- .../functions/infinitequeryoptions.md | 8 +- .../reference/functions/queryoptions.md | 20 ++- .../functions/setisrestoringcontext.md | 6 +- .../functions/setqueryclientcontext.md | 6 +- .../svelte/reference/functions/usehydrate.md | 14 +- .../reference/functions/useisfetching.md | 10 +- .../reference/functions/useismutating.md | 10 +- .../reference/functions/useisrestoring.md | 2 +- .../reference/functions/usemutationstate.md | 10 +- .../reference/functions/usequeryclient.md | 6 +- .../type-aliases/createbasemutationresult.md | 10 +- .../type-aliases/createbasequeryoptions.md | 10 +- .../type-aliases/createbasequeryresult.md | 6 +- .../createinfinitequeryoptions.md | 18 ++- .../type-aliases/createinfinitequeryresult.md | 6 +- .../type-aliases/createmutateasyncfunction.md | 5 +- .../type-aliases/createmutatefunction.md | 10 +- .../type-aliases/createmutationoptions.md | 7 +- .../type-aliases/createmutationresult.md | 6 +- .../type-aliases/createqueryoptions.md | 5 +- .../type-aliases/createqueryresult.md | 4 +- .../definedcreatebasequeryresult.md | 6 +- .../type-aliases/definedcreatequeryresult.md | 7 +- .../type-aliases/definedinitialdataoptions.md | 9 +- .../type-aliases/mutationstateoptions.md | 8 +- .../reference/type-aliases/queriesoptions.md | 31 +++- .../reference/type-aliases/queriesresults.md | 27 +++- .../reference/type-aliases/storeorval.md | 4 +- .../undefinedinitialdataoptions.md | 7 +- 77 files changed, 1179 insertions(+), 380 deletions(-) create mode 100644 docs/framework/angular/reference/functions/mutationoptions.md create mode 100644 docs/framework/angular/reference/functions/providetanstackquery.md create mode 100644 docs/framework/angular/reference/functions/withdevtools.md create mode 100644 docs/framework/angular/reference/interfaces/devtoolsoptions.md create mode 100644 docs/framework/angular/reference/interfaces/queryfeature.md create mode 100644 docs/framework/angular/reference/type-aliases/developertoolsfeature.md create mode 100644 docs/framework/angular/reference/type-aliases/queryfeaturekind.md create mode 100644 docs/framework/angular/reference/type-aliases/queryfeatures.md create mode 100644 docs/framework/angular/reference/variables/queryfeatures.md diff --git a/docs/framework/angular/reference/functions/infinitequeryoptions.md b/docs/framework/angular/reference/functions/infinitequeryoptions.md index 9d76ed9456..b521cd336b 100644 --- a/docs/framework/angular/reference/functions/infinitequeryoptions.md +++ b/docs/framework/angular/reference/functions/infinitequeryoptions.md @@ -13,7 +13,7 @@ The `queryKey` will be tagged with the type from `queryFn`. The infinite query options to tag with the type from `queryFn`. -## infiniteQueryOptions(options) +## Call Signature ```ts function infiniteQueryOptions< @@ -24,7 +24,7 @@ function infiniteQueryOptions< TPageParam, >( options, -): UndefinedInitialDataInfiniteOptions< +): DefinedInitialDataInfiniteOptions< TQueryFnData, TError, TData, @@ -46,19 +46,21 @@ The `queryKey` will be tagged with the type from `queryFn`. • **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] • **TPageParam** = `unknown` ### Parameters -• **options**: [`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> +#### options + +[`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> The infinite query options to tag with the type from `queryFn`. ### Returns -[`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` +[`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` The tagged infinite query options. @@ -70,9 +72,9 @@ The infinite query options to tag with the type from `queryFn`. ### Defined in -[infinite-query-options.ts:59](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/infinite-query-options.ts#L59) +[infinite-query-options.ts:59](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L59) -## infiniteQueryOptions(options) +## Call Signature ```ts function infiniteQueryOptions< @@ -83,7 +85,7 @@ function infiniteQueryOptions< TPageParam, >( options, -): DefinedInitialDataInfiniteOptions< +): UndefinedInitialDataInfiniteOptions< TQueryFnData, TError, TData, @@ -105,19 +107,21 @@ The `queryKey` will be tagged with the type from `queryFn`. • **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] • **TPageParam** = `unknown` ### Parameters -• **options**: [`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> +#### options + +[`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> The infinite query options to tag with the type from `queryFn`. ### Returns -[`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` +[`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` The tagged infinite query options. @@ -129,4 +133,4 @@ The infinite query options to tag with the type from `queryFn`. ### Defined in -[infinite-query-options.ts:91](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/infinite-query-options.ts#L91) +[infinite-query-options.ts:91](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L91) diff --git a/docs/framework/angular/reference/functions/injectinfinitequery.md b/docs/framework/angular/reference/functions/injectinfinitequery.md index 225f71d041..fc40a60f6b 100644 --- a/docs/framework/angular/reference/functions/injectinfinitequery.md +++ b/docs/framework/angular/reference/functions/injectinfinitequery.md @@ -16,7 +16,7 @@ A function that returns infinite query options. The Angular injector to use. -## injectInfiniteQuery(optionsFn, injector) +## Call Signature ```ts function injectInfiniteQuery< @@ -25,7 +25,7 @@ function injectInfiniteQuery< TData, TQueryKey, TPageParam, ->(optionsFn, injector?): CreateInfiniteQueryResult +>(optionsFn, injector?): DefinedCreateInfiniteQueryResult ``` Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key. @@ -39,23 +39,27 @@ Infinite queries can additively "load more" data onto an existing set of data or • **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] • **TPageParam** = `unknown` ### Parameters -• **optionsFn** +#### optionsFn + +() => [`DefinedInitialDataInfiniteOptions`](../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> A function that returns infinite query options. -• **injector?**: `Injector` +#### injector? + +`Injector` The Angular injector to use. ### Returns -[`CreateInfiniteQueryResult`](../type-aliases/createinfinitequeryresult.md)\<`TData`, `TError`\> +[`DefinedCreateInfiniteQueryResult`](../type-aliases/definedcreateinfinitequeryresult.md)\<`TData`, `TError`\> The infinite query result. @@ -71,9 +75,9 @@ The Angular injector to use. ### Defined in -[inject-infinite-query.ts:30](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-infinite-query.ts#L30) +[inject-infinite-query.ts:29](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L29) -## injectInfiniteQuery(optionsFn, injector) +## Call Signature ```ts function injectInfiniteQuery< @@ -82,7 +86,7 @@ function injectInfiniteQuery< TData, TQueryKey, TPageParam, ->(optionsFn, injector?): DefinedCreateInfiniteQueryResult +>(optionsFn, injector?): CreateInfiniteQueryResult ``` Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key. @@ -96,23 +100,27 @@ Infinite queries can additively "load more" data onto an existing set of data or • **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] • **TPageParam** = `unknown` ### Parameters -• **optionsFn** +#### optionsFn + +() => [`UndefinedInitialDataInfiniteOptions`](../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> A function that returns infinite query options. -• **injector?**: `Injector` +#### injector? + +`Injector` The Angular injector to use. ### Returns -[`DefinedCreateInfiniteQueryResult`](../type-aliases/definedcreateinfinitequeryresult.md)\<`TData`, `TError`\> +[`CreateInfiniteQueryResult`](../type-aliases/createinfinitequeryresult.md)\<`TData`, `TError`\> The infinite query result. @@ -128,9 +136,9 @@ The Angular injector to use. ### Defined in -[inject-infinite-query.ts:57](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-infinite-query.ts#L57) +[inject-infinite-query.ts:54](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L54) -## injectInfiniteQuery(optionsFn, injector) +## Call Signature ```ts function injectInfiniteQuery< @@ -153,17 +161,21 @@ Infinite queries can additively "load more" data onto an existing set of data or • **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] • **TPageParam** = `unknown` ### Parameters -• **optionsFn** +#### optionsFn + +() => [`CreateInfiniteQueryOptions`](../interfaces/createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\> A function that returns infinite query options. -• **injector?**: `Injector` +#### injector? + +`Injector` The Angular injector to use. @@ -185,4 +197,4 @@ The Angular injector to use. ### Defined in -[inject-infinite-query.ts:84](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-infinite-query.ts#L84) +[inject-infinite-query.ts:79](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L79) diff --git a/docs/framework/angular/reference/functions/injectisfetching.md b/docs/framework/angular/reference/functions/injectisfetching.md index 79a7335ba3..541d3a8bff 100644 --- a/docs/framework/angular/reference/functions/injectisfetching.md +++ b/docs/framework/angular/reference/functions/injectisfetching.md @@ -16,11 +16,15 @@ Can be used for app-wide loading indicators ## Parameters -• **filters?**: `QueryFilters` +### filters? + +`QueryFilters`\<`unknown`, `Error`, `unknown`, readonly `unknown`[]\> The filters to apply to the query. -• **injector?**: `Injector` +### injector? + +`Injector` The Angular injector to use. @@ -32,4 +36,4 @@ signal with number of loading or fetching queries. ## Defined in -[inject-is-fetching.ts:17](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-is-fetching.ts#L17) +[inject-is-fetching.ts:17](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-fetching.ts#L17) diff --git a/docs/framework/angular/reference/functions/injectismutating.md b/docs/framework/angular/reference/functions/injectismutating.md index 210fdf4d56..bd80d15950 100644 --- a/docs/framework/angular/reference/functions/injectismutating.md +++ b/docs/framework/angular/reference/functions/injectismutating.md @@ -15,11 +15,15 @@ Can be used for app-wide loading indicators ## Parameters -• **filters?**: `MutationFilters` +### filters? + +`MutationFilters`\<`unknown`, `Error`, `unknown`, `unknown`\> The filters to apply to the query. -• **injector?**: `Injector` +### injector? + +`Injector` The Angular injector to use. @@ -31,4 +35,4 @@ signal with number of fetching mutations. ## Defined in -[inject-is-mutating.ts:16](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-is-mutating.ts#L16) +[inject-is-mutating.ts:16](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-mutating.ts#L16) diff --git a/docs/framework/angular/reference/functions/injectmutation.md b/docs/framework/angular/reference/functions/injectmutation.md index f649b79e96..7a2a85f9c6 100644 --- a/docs/framework/angular/reference/functions/injectmutation.md +++ b/docs/framework/angular/reference/functions/injectmutation.md @@ -28,11 +28,15 @@ Unlike queries, mutations are not run automatically. ## Parameters -• **optionsFn** +### optionsFn + +() => [`CreateMutationOptions`](../interfaces/createmutationoptions.md)\<`TData`, `TError`, `TVariables`, `TContext`\> A function that returns mutation options. -• **injector?**: `Injector` +### injector? + +`Injector` The Angular injector to use. @@ -44,4 +48,4 @@ The mutation. ## Defined in -[inject-mutation.ts:38](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-mutation.ts#L38) +[inject-mutation.ts:33](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L33) diff --git a/docs/framework/angular/reference/functions/injectmutationstate.md b/docs/framework/angular/reference/functions/injectmutationstate.md index 899067a3c6..b56caa7157 100644 --- a/docs/framework/angular/reference/functions/injectmutationstate.md +++ b/docs/framework/angular/reference/functions/injectmutationstate.md @@ -20,11 +20,15 @@ Injects a signal that tracks the state of all mutations. ## Parameters -• **mutationStateOptionsFn** = `...` +### mutationStateOptionsFn + +() => `MutationStateOptions`\<`TResult`\> A function that returns mutation state options. -• **options?**: [`InjectMutationStateOptions`](../interfaces/injectmutationstateoptions.md) +### options? + +[`InjectMutationStateOptions`](../interfaces/injectmutationstateoptions.md) The Angular injector to use. @@ -36,4 +40,4 @@ The signal that tracks the state of all mutations. ## Defined in -[inject-mutation-state.ts:53](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-mutation-state.ts#L53) +[inject-mutation-state.ts:47](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation-state.ts#L47) diff --git a/docs/framework/angular/reference/functions/injectqueries.md b/docs/framework/angular/reference/functions/injectqueries.md index 89403c640d..4840d054ba 100644 --- a/docs/framework/angular/reference/functions/injectqueries.md +++ b/docs/framework/angular/reference/functions/injectqueries.md @@ -20,13 +20,19 @@ function injectQueries( ## Parameters -• **\_\_namedParameters** +### \_\_namedParameters -• **\_\_namedParameters.combine?** +#### combine -• **\_\_namedParameters.queries?**: `Signal`\<[`...(T extends [] ? [] : T extends [Head] ? [GetOptions] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions, GetOptions] : [...Tail[]] extends [Head, ...Tail[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[])[]`]\> +(`result`) => `TCombinedResult` -• **injector?**: `Injector` +#### queries + +`Signal`\<[`...(T extends [] ? [] : T extends [Head] ? [GetOptions] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions, GetOptions] : [...Tail[]] extends [Head, ...Tail[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[])[]`]\> + +### injector? + +`Injector` ## Returns @@ -34,4 +40,4 @@ function injectQueries( ## Defined in -[inject-queries.ts:188](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-queries.ts#L188) +[inject-queries.ts:198](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L198) diff --git a/docs/framework/angular/reference/functions/injectquery.md b/docs/framework/angular/reference/functions/injectquery.md index aa0b3196bf..a4de522ad3 100644 --- a/docs/framework/angular/reference/functions/injectquery.md +++ b/docs/framework/angular/reference/functions/injectquery.md @@ -50,7 +50,7 @@ The Angular injector to use. https://tanstack.com/query/latest/docs/framework/angular/guides/queries -## injectQuery(optionsFn, injector) +## Call Signature ```ts function injectQuery( @@ -100,15 +100,19 @@ class ServiceOrComponent { • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] ### Parameters -• **optionsFn** +#### optionsFn + +() => [`DefinedInitialDataOptions`](../type-aliases/definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> A function that returns query options. -• **injector?**: `Injector` +#### injector? + +`Injector` The Angular injector to use. @@ -138,9 +142,9 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries ### Defined in -[inject-query.ts:53](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query.ts#L53) +[inject-query.ts:53](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L53) -## injectQuery(optionsFn, injector) +## Call Signature ```ts function injectQuery( @@ -190,15 +194,19 @@ class ServiceOrComponent { • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] ### Parameters -• **optionsFn** +#### optionsFn + +() => [`UndefinedInitialDataOptions`](../type-aliases/undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> A function that returns query options. -• **injector?**: `Injector` +#### injector? + +`Injector` The Angular injector to use. @@ -228,9 +236,9 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries ### Defined in -[inject-query.ts:102](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query.ts#L102) +[inject-query.ts:105](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L105) -## injectQuery(optionsFn, injector) +## Call Signature ```ts function injectQuery( @@ -280,15 +288,19 @@ class ServiceOrComponent { • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] ### Parameters -• **optionsFn** +#### optionsFn + +() => [`CreateQueryOptions`](../interfaces/createqueryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> A function that returns query options. -• **injector?**: `Injector` +#### injector? + +`Injector` The Angular injector to use. @@ -318,4 +330,4 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries ### Defined in -[inject-query.ts:151](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query.ts#L151) +[inject-query.ts:157](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L157) diff --git a/docs/framework/angular/reference/functions/injectqueryclient.md b/docs/framework/angular/reference/functions/injectqueryclient.md index ebe9bc821c..fbe1a39573 100644 --- a/docs/framework/angular/reference/functions/injectqueryclient.md +++ b/docs/framework/angular/reference/functions/injectqueryclient.md @@ -3,71 +3,32 @@ id: injectQueryClient title: injectQueryClient --- -# Function: injectQueryClient() - -Injects the `QueryClient` instance into the component or service. - -**Example** - -```ts -const queryClient = injectQueryClient() -``` - -## injectQueryClient() - -```ts -function injectQueryClient(): QueryClient -``` - -Injects the `QueryClient` instance into the component or service. - -**Example** - -```ts -const queryClient = injectQueryClient() -``` - -### Returns - -`QueryClient` - -### Defined in - -[inject-query-client.ts:16](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query-client.ts#L16) - -## injectQueryClient(injectOptions) +# Function: ~~injectQueryClient()~~ ```ts function injectQueryClient(injectOptions): QueryClient ``` -Injects the `QueryClient` instance into the component or service. +Injects a `QueryClient` instance and allows passing a custom injector. -**Example** +## Parameters -```ts -const queryClient = injectQueryClient() -``` +### injectOptions -### Parameters +`InjectOptions` & `object` = `{}` -• **injectOptions**: `InjectOptions` & `object` & `object` +Type of the options argument to inject and optionally a custom injector. -### Returns +## Returns `QueryClient` -### Defined in - -[inject-query-client.ts:16](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query-client.ts#L16) - -## injectQueryClient(injectOptions) +The `QueryClient` instance. -```ts -function injectQueryClient(injectOptions): null | QueryClient -``` +## Deprecated -Injects the `QueryClient` instance into the component or service. +Use `inject(QueryClient)` instead. +If you need to get a `QueryClient` from a custom injector, use `injector.get(QueryClient)`. **Example** @@ -75,14 +36,6 @@ Injects the `QueryClient` instance into the component or service. const queryClient = injectQueryClient() ``` -### Parameters - -• **injectOptions**: `InjectOptions` & `object` - -### Returns - -`null` \| `QueryClient` - -### Defined in +## Defined in -[inject-query-client.ts:16](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query-client.ts#L16) +[inject-query-client.ts:19](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query-client.ts#L19) diff --git a/docs/framework/angular/reference/functions/mutationoptions.md b/docs/framework/angular/reference/functions/mutationoptions.md new file mode 100644 index 0000000000..3acb8200ce --- /dev/null +++ b/docs/framework/angular/reference/functions/mutationoptions.md @@ -0,0 +1,67 @@ +--- +id: mutationOptions +title: mutationOptions +--- + +# Function: mutationOptions() + +```ts +function mutationOptions( + options, +): CreateMutationOptions +``` + +Allows to share and re-use mutation options in a type-safe way. + +**Example** + +```ts +export class QueriesService { + private http = inject(HttpClient) + + updatePost(id: number) { + return mutationOptions({ + mutationFn: (post: Post) => Promise.resolve(post), + mutationKey: ['updatePost', id], + onSuccess: (newPost) => { + // ^? newPost: Post + this.queryClient.setQueryData(['posts', id], newPost) + }, + }) + } +} + +queries = inject(QueriesService) +idSignal = new Signal(0) +mutation = injectMutation(() => this.queries.updatePost(this.idSignal())) + +mutation.mutate({ title: 'New Title' }) +``` + +## Type Parameters + +• **TData** = `unknown` + +• **TError** = `Error` + +• **TVariables** = `void` + +• **TContext** = `unknown` + +## Parameters + +### options + +`MutationObserverOptions`\<`TData`, `TError`, `TVariables`, `TContext`\> + +The mutation options. + +## Returns + +[`CreateMutationOptions`](../interfaces/createmutationoptions.md)\<`TData`, `TError`, `TVariables`, `TContext`\> + +Mutation options. + +## Defined in + +[mutation-options.ts:38](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/mutation-options.ts#L38) diff --git a/docs/framework/angular/reference/functions/provideangularquery.md b/docs/framework/angular/reference/functions/provideangularquery.md index f6d84bb926..5b43fd3665 100644 --- a/docs/framework/angular/reference/functions/provideangularquery.md +++ b/docs/framework/angular/reference/functions/provideangularquery.md @@ -3,7 +3,7 @@ id: provideAngularQuery title: provideAngularQuery --- -# Function: provideAngularQuery() +# Function: ~~provideAngularQuery()~~ ```ts function provideAngularQuery(queryClient): EnvironmentProviders @@ -13,39 +13,11 @@ Sets up providers necessary to enable TanStack Query functionality for Angular a Allows to configure a `QueryClient`. -**Example - standalone** - -```ts -import { - provideAngularQuery, - QueryClient, -} from '@tanstack/angular-query-experimental' - -bootstrapApplication(AppComponent, { - providers: [provideAngularQuery(new QueryClient())], -}) -``` - -**Example - NgModule-based** - -```ts -import { - provideAngularQuery, - QueryClient, -} from '@tanstack/angular-query-experimental' - -@NgModule({ - declarations: [AppComponent], - imports: [BrowserModule], - providers: [provideAngularQuery(new QueryClient())], - bootstrap: [AppComponent], -}) -export class AppModule {} -``` - ## Parameters -• **queryClient**: `QueryClient` +### queryClient + +`QueryClient` A `QueryClient` instance. @@ -59,6 +31,10 @@ A set of providers to set up TanStack Query. https://tanstack.com/query/v5/docs/framework/angular/quick-start +## Deprecated + +Use `provideTanStackQuery` instead. + ## Defined in -[providers.ts:50](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/providers.ts#L50) +[providers.ts:125](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L125) diff --git a/docs/framework/angular/reference/functions/providequeryclient.md b/docs/framework/angular/reference/functions/providequeryclient.md index b7de8ecb87..e381268816 100644 --- a/docs/framework/angular/reference/functions/providequeryclient.md +++ b/docs/framework/angular/reference/functions/providequeryclient.md @@ -6,22 +6,38 @@ title: provideQueryClient # Function: provideQueryClient() ```ts -function provideQueryClient(value): Provider +function provideQueryClient(queryClient): object ``` -Usually [provideAngularQuery](provideangularquery.md) is used once to set up TanStack Query and the -[https://tanstack.com/query/latest/docs/reference/QueryClient|QueryClient](https://tanstack.com/query/latest/docs/reference/QueryClient|QueryClient) +Usually [provideTanStackQuery](providetanstackquery.md) is used once to set up TanStack Query and the +[https://tanstack.com/query/latest/docs/reference/QueryClient\|QueryClient](https://tanstack.com/query/latest/docs/reference/QueryClient|QueryClient) for the entire application. You can use `provideQueryClient` to provide a different `QueryClient` instance for a part of the application. ## Parameters -• **value**: `QueryClient` \| () => `QueryClient` +### queryClient + +`QueryClient` + +the `QueryClient` instance to provide. ## Returns -`Provider` +`object` + +### provide + +```ts +provide: typeof QueryClient = QueryClient; +``` + +### useValue + +```ts +useValue: QueryClient = queryClient +``` ## Defined in -[inject-query-client.ts:25](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-query-client.ts#L25) +[providers.ts:32](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L32) diff --git a/docs/framework/angular/reference/functions/providetanstackquery.md b/docs/framework/angular/reference/functions/providetanstackquery.md new file mode 100644 index 0000000000..c69620029a --- /dev/null +++ b/docs/framework/angular/reference/functions/providetanstackquery.md @@ -0,0 +1,92 @@ +--- +id: provideTanStackQuery +title: provideTanStackQuery +--- + +# Function: provideTanStackQuery() + +```ts +function provideTanStackQuery(queryClient, ...features): EnvironmentProviders +``` + +Sets up providers necessary to enable TanStack Query functionality for Angular applications. + +Allows to configure a `QueryClient` and optional features such as developer tools. + +**Example - standalone** + +```ts +import { + provideTanStackQuery, + QueryClient, +} from '@tanstack/angular-query-experimental' + +bootstrapApplication(AppComponent, { + providers: [provideTanStackQuery(new QueryClient())], +}) +``` + +**Example - NgModule-based** + +```ts +import { + provideTanStackQuery, + QueryClient, +} from '@tanstack/angular-query-experimental' + +@NgModule({ + declarations: [AppComponent], + imports: [BrowserModule], + providers: [provideTanStackQuery(new QueryClient())], + bootstrap: [AppComponent], +}) +export class AppModule {} +``` + +You can also enable optional developer tools by adding `withDevtools`. By +default the tools will then be loaded when your app is in development mode. + +```ts +import { + provideTanStackQuery, + withDevtools + QueryClient, +} from '@tanstack/angular-query-experimental' + +bootstrapApplication(AppComponent, + { + providers: [ + provideTanStackQuery(new QueryClient(), withDevtools()) + ] + } +) +``` + +## Parameters + +### queryClient + +`QueryClient` + +A `QueryClient` instance. + +### features + +...[`DeveloperToolsFeature`](../type-aliases/developertoolsfeature.md)[] + +Optional features to configure additional Query functionality. + +## Returns + +`EnvironmentProviders` + +A set of providers to set up TanStack Query. + +## See + +- https://tanstack.com/query/v5/docs/framework/angular/quick-start +- withDevtools + +## Defined in + +[providers.ts:95](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L95) diff --git a/docs/framework/angular/reference/functions/queryoptions.md b/docs/framework/angular/reference/functions/queryoptions.md index 05f9cc0a10..99c3ad8fac 100644 --- a/docs/framework/angular/reference/functions/queryoptions.md +++ b/docs/framework/angular/reference/functions/queryoptions.md @@ -27,12 +27,12 @@ const data = queryClient.getQueryData(queryKey) The query options to tag with the type from `queryFn`. -## queryOptions(options) +## Call Signature ```ts function queryOptions( options, -): UndefinedInitialDataOptions & object +): DefinedInitialDataOptions & object ``` Allows to share and re-use query options in a type-safe way. @@ -61,17 +61,19 @@ const data = queryClient.getQueryData(queryKey) • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] ### Parameters -• **options**: [`UndefinedInitialDataOptions`](../type-aliases/undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> +#### options + +[`DefinedInitialDataOptions`](../type-aliases/definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> The query options to tag with the type from `queryFn`. ### Returns -[`UndefinedInitialDataOptions`](../type-aliases/undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` +[`DefinedInitialDataOptions`](../type-aliases/definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` The tagged query options. @@ -83,14 +85,14 @@ The query options to tag with the type from `queryFn`. ### Defined in -[query-options.ts:52](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/query-options.ts#L52) +[query-options.ts:57](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L57) -## queryOptions(options) +## Call Signature ```ts function queryOptions( options, -): DefinedInitialDataOptions & object +): UndefinedInitialDataOptions & object ``` Allows to share and re-use query options in a type-safe way. @@ -119,17 +121,19 @@ const data = queryClient.getQueryData(queryKey) • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] ### Parameters -• **options**: [`DefinedInitialDataOptions`](../type-aliases/definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> +#### options + +[`UndefinedInitialDataOptions`](../type-aliases/undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> The query options to tag with the type from `queryFn`. ### Returns -[`DefinedInitialDataOptions`](../type-aliases/definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` +[`UndefinedInitialDataOptions`](../type-aliases/undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` The tagged query options. @@ -141,4 +145,4 @@ The query options to tag with the type from `queryFn`. ### Defined in -[query-options.ts:85](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/query-options.ts#L85) +[query-options.ts:90](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L90) diff --git a/docs/framework/angular/reference/functions/withdevtools.md b/docs/framework/angular/reference/functions/withdevtools.md new file mode 100644 index 0000000000..177bea40ec --- /dev/null +++ b/docs/framework/angular/reference/functions/withdevtools.md @@ -0,0 +1,49 @@ +--- +id: withDevtools +title: withDevtools +--- + +# Function: withDevtools() + +```ts +function withDevtools(optionsFn?): DeveloperToolsFeature +``` + +Enables developer tools. + +**Example** + +```ts +export const appConfig: ApplicationConfig = { + providers: [provideTanStackQuery(new QueryClient(), withDevtools())], +} +``` + +By default the devtools will be loaded when Angular runs in development mode and rendered in ``. + +If you need more control over when devtools are loaded, you can use the `loadDevtools` option. This is particularly useful if you want to load devtools based on environment configurations. For instance, you might have a test environment running in production mode but still require devtools to be available. + +If you need more control over where devtools are rendered, consider `injectDevtoolsPanel`. This allows rendering devtools inside your own devtools for example. + +## Parameters + +### optionsFn? + +() => [`DevtoolsOptions`](../interfaces/devtoolsoptions.md) + +A function that returns `DevtoolsOptions`. + +## Returns + +[`DeveloperToolsFeature`](../type-aliases/developertoolsfeature.md) + +A set of providers for use with `provideTanStackQuery`. + +## See + +- [provideTanStackQuery](providetanstackquery.md) +- [DevtoolsOptions](../interfaces/devtoolsoptions.md) + +## Defined in + +[providers.ts:244](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L244) diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md index a0f861def3..f26424adb9 100644 --- a/docs/framework/angular/reference/index.md +++ b/docs/framework/angular/reference/index.md @@ -13,7 +13,9 @@ title: '@tanstack/angular-query-experimental' - [CreateInfiniteQueryOptions](interfaces/createinfinitequeryoptions.md) - [CreateMutationOptions](interfaces/createmutationoptions.md) - [CreateQueryOptions](interfaces/createqueryoptions.md) +- [DevtoolsOptions](interfaces/devtoolsoptions.md) - [InjectMutationStateOptions](interfaces/injectmutationstateoptions.md) +- [QueryFeature](interfaces/queryfeature.md) ## Type Aliases @@ -28,12 +30,19 @@ title: '@tanstack/angular-query-experimental' - [DefinedCreateQueryResult](type-aliases/definedcreatequeryresult.md) - [DefinedInitialDataInfiniteOptions](type-aliases/definedinitialdatainfiniteoptions.md) - [DefinedInitialDataOptions](type-aliases/definedinitialdataoptions.md) +- [DeveloperToolsFeature](type-aliases/developertoolsfeature.md) - [NonUndefinedGuard](type-aliases/nonundefinedguard.md) - [QueriesOptions](type-aliases/queriesoptions.md) - [QueriesResults](type-aliases/queriesresults.md) +- [QueryFeatureKind](type-aliases/queryfeaturekind.md) +- [QueryFeatures](type-aliases/queryfeatures.md) - [UndefinedInitialDataInfiniteOptions](type-aliases/undefinedinitialdatainfiniteoptions.md) - [UndefinedInitialDataOptions](type-aliases/undefinedinitialdataoptions.md) +## Variables + +- [queryFeatures](variables/queryfeatures.md) + ## Functions - [infiniteQueryOptions](functions/infinitequeryoptions.md) @@ -45,6 +54,9 @@ title: '@tanstack/angular-query-experimental' - [injectQueries](functions/injectqueries.md) - [injectQuery](functions/injectquery.md) - [injectQueryClient](functions/injectqueryclient.md) +- [mutationOptions](functions/mutationoptions.md) - [provideAngularQuery](functions/provideangularquery.md) - [provideQueryClient](functions/providequeryclient.md) +- [provideTanStackQuery](functions/providetanstackquery.md) - [queryOptions](functions/queryoptions.md) +- [withDevtools](functions/withdevtools.md) diff --git a/docs/framework/angular/reference/interfaces/basemutationnarrowing.md b/docs/framework/angular/reference/interfaces/basemutationnarrowing.md index 96ddd7fa63..458adf172e 100644 --- a/docs/framework/angular/reference/interfaces/basemutationnarrowing.md +++ b/docs/framework/angular/reference/interfaces/basemutationnarrowing.md @@ -17,80 +17,128 @@ title: BaseMutationNarrowing ## Properties -### isError() +### isError ```ts -isError: (this) => this is CreateMutationResult, Object> & Object>; +isError: SignalFunction< + ( + this, + ) => this is CreateMutationResult< + TData, + TError, + TVariables, + TContext, + Override< + MutationObserverErrorResult, + { mutate: CreateMutateFunction } + > & { + mutateAsync: CreateMutateAsyncFunction< + TData, + TError, + TVariables, + TContext + > + } + > +> ``` -#### Parameters - -• **this**: [`CreateMutationResult`](../type-aliases/createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\> - -#### Returns - -`this is CreateMutationResult, Object> & Object>` - #### Defined in -[types.ts:248](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/types.ts#L248) +[types.ts:241](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L241) --- -### isIdle() +### isIdle ```ts -isIdle: (this) => this is CreateMutationResult, Object> & Object>; +isIdle: SignalFunction< + ( + this, + ) => this is CreateMutationResult< + TData, + TError, + TVariables, + TContext, + Override< + MutationObserverIdleResult, + { mutate: CreateMutateFunction } + > & { + mutateAsync: CreateMutateAsyncFunction< + TData, + TError, + TVariables, + TContext + > + } + > +> ``` -#### Parameters - -• **this**: [`CreateMutationResult`](../type-aliases/createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\> - -#### Returns - -`this is CreateMutationResult, Object> & Object>` - #### Defined in -[types.ts:278](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/types.ts#L278) +[types.ts:275](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L275) --- -### isPending() +### isPending ```ts -isPending: (this) => this is CreateMutationResult, Object> & Object>; +isPending: SignalFunction< + ( + this, + ) => this is CreateMutationResult< + TData, + TError, + TVariables, + TContext, + Override< + MutationObserverLoadingResult, + { mutate: CreateMutateFunction } + > & { + mutateAsync: CreateMutateAsyncFunction< + TData, + TError, + TVariables, + TContext + > + } + > +> ``` -#### Parameters - -• **this**: [`CreateMutationResult`](../type-aliases/createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\> - -#### Returns - -`this is CreateMutationResult, Object> & Object>` - #### Defined in -[types.ts:263](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/types.ts#L263) +[types.ts:258](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L258) --- -### isSuccess() +### isSuccess ```ts -isSuccess: (this) => this is CreateMutationResult, Object> & Object>; +isSuccess: SignalFunction< + ( + this, + ) => this is CreateMutationResult< + TData, + TError, + TVariables, + TContext, + Override< + MutationObserverSuccessResult, + { mutate: CreateMutateFunction } + > & { + mutateAsync: CreateMutateAsyncFunction< + TData, + TError, + TVariables, + TContext + > + } + > +> ``` -#### Parameters - -• **this**: [`CreateMutationResult`](../type-aliases/createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TContext`, `CreateStatusBasedMutationResult`\<`"error"` \| `"success"` \| `"pending"` \| `"idle"`, `TData`, `TError`, `TVariables`, `TContext`\>\> - -#### Returns - -`this is CreateMutationResult, Object> & Object>` - #### Defined in -[types.ts:233](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/types.ts#L233) +[types.ts:224](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L224) diff --git a/docs/framework/angular/reference/interfaces/basequerynarrowing.md b/docs/framework/angular/reference/interfaces/basequerynarrowing.md index 2030db4067..649539af2a 100644 --- a/docs/framework/angular/reference/interfaces/basequerynarrowing.md +++ b/docs/framework/angular/reference/interfaces/basequerynarrowing.md @@ -21,7 +21,9 @@ isError: (this) => this is CreateBaseQueryResult\> +##### this + +[`CreateBaseQueryResult`](../type-aliases/createbasequeryresult.md)\<`TData`, `TError`, `QueryObserverResult`\<`TData`, `TError`\>\> #### Returns @@ -29,7 +31,7 @@ isError: (this) => this is CreateBaseQueryResult this is CreateBaseQueryResult\> +##### this + +[`CreateBaseQueryResult`](../type-aliases/createbasequeryresult.md)\<`TData`, `TError`, `QueryObserverResult`\<`TData`, `TError`\>\> #### Returns @@ -49,7 +53,7 @@ isPending: (this) => this is CreateBaseQueryResult this is CreateBaseQueryResult\> +##### this + +[`CreateBaseQueryResult`](../type-aliases/createbasequeryresult.md)\<`TData`, `TError`, `QueryObserverResult`\<`TData`, `TError`\>\> #### Returns @@ -69,4 +75,4 @@ isSuccess: (this) => this is CreateBaseQueryResult ({ + initialIsOpen: true, + loadDevtools: inject(ExampleService).loadDevtools(), +})) +``` + +#### Defined in + +[providers.ts:218](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L218) + +--- + +### position? + +```ts +optional position: DevtoolsPosition; +``` + +The position of the TanStack Query devtools panel. +`top` | `bottom` | `left` | `right` +Defaults to `bottom`. + +#### Defined in + +[providers.ts:180](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L180) + +--- + +### shadowDOMTarget? + +```ts +optional shadowDOMTarget: ShadowRoot; +``` + +Use this so you can attach the devtool's styles to a specific element in the DOM. + +#### Defined in + +[providers.ts:196](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L196) + +--- + +### styleNonce? + +```ts +optional styleNonce: string; +``` + +Use this to pass a nonce to the style tag that is added to the document head. This is useful if you are using a Content Security Policy (CSP) nonce to allow inline styles. + +#### Defined in + +[providers.ts:192](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L192) diff --git a/docs/framework/angular/reference/interfaces/injectmutationstateoptions.md b/docs/framework/angular/reference/interfaces/injectmutationstateoptions.md index 15fe330c5c..9c6d160a34 100644 --- a/docs/framework/angular/reference/interfaces/injectmutationstateoptions.md +++ b/docs/framework/angular/reference/interfaces/injectmutationstateoptions.md @@ -15,4 +15,4 @@ optional injector: Injector; #### Defined in -[inject-mutation-state.ts:43](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-mutation-state.ts#L43) +[inject-mutation-state.ts:37](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation-state.ts#L37) diff --git a/docs/framework/angular/reference/interfaces/queryfeature.md b/docs/framework/angular/reference/interfaces/queryfeature.md new file mode 100644 index 0000000000..c746b8318e --- /dev/null +++ b/docs/framework/angular/reference/interfaces/queryfeature.md @@ -0,0 +1,36 @@ +--- +id: QueryFeature +title: QueryFeature +--- + +# Interface: QueryFeature\ + +Helper type to represent a Query feature. + +## Type Parameters + +• **TFeatureKind** _extends_ [`QueryFeatureKind`](../type-aliases/queryfeaturekind.md) + +## Properties + +### ɵkind + +```ts +ɵkind: TFeatureKind +``` + +#### Defined in + +[providers.ts:135](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L135) + +--- + +### ɵproviders + +```ts +ɵproviders: Provider[]; +``` + +#### Defined in + +[providers.ts:136](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L136) diff --git a/docs/framework/angular/reference/type-aliases/createbasemutationresult.md b/docs/framework/angular/reference/type-aliases/createbasemutationresult.md index 3cad41d423..54b68f780f 100644 --- a/docs/framework/angular/reference/type-aliases/createbasemutationresult.md +++ b/docs/framework/angular/reference/type-aliases/createbasemutationresult.md @@ -6,7 +6,13 @@ title: CreateBaseMutationResult # Type Alias: CreateBaseMutationResult\ ```ts -type CreateBaseMutationResult: Override, object> & object; +type CreateBaseMutationResult = Override< + MutationObserverResult, + { + mutate: CreateMutateFunction + } +> & + object ``` ## Type declaration @@ -29,4 +35,4 @@ mutateAsync: CreateMutateAsyncFunction ## Defined in -[types.ts:198](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/types.ts#L198) +[types.ts:187](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L187) diff --git a/docs/framework/angular/reference/type-aliases/createbasequeryresult.md b/docs/framework/angular/reference/type-aliases/createbasequeryresult.md index 3870240677..f8b5b1d147 100644 --- a/docs/framework/angular/reference/type-aliases/createbasequeryresult.md +++ b/docs/framework/angular/reference/type-aliases/createbasequeryresult.md @@ -6,7 +6,11 @@ title: CreateBaseQueryResult # Type Alias: CreateBaseQueryResult\ ```ts -type CreateBaseQueryResult: BaseQueryNarrowing & MapToSignals>; +type CreateBaseQueryResult = BaseQueryNarrowing< + TData, + TError +> & + MapToSignals> ``` ## Type Parameters @@ -19,4 +23,4 @@ type CreateBaseQueryResult: BaseQueryNarrowing ```ts -type CreateInfiniteQueryResult: MapToSignals>; +type CreateInfiniteQueryResult = MapToSignals< + InfiniteQueryObserverResult +> ``` ## Type Parameters @@ -17,4 +19,4 @@ type CreateInfiniteQueryResult: MapToSignals ```ts -type CreateMutateAsyncFunction: MutateFunction; +type CreateMutateAsyncFunction = + MutateFunction ``` ## Type Parameters @@ -21,4 +22,4 @@ type CreateMutateAsyncFunction: MutateFunct ## Defined in -[types.ts:188](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/types.ts#L188) +[types.ts:177](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L177) diff --git a/docs/framework/angular/reference/type-aliases/createmutatefunction.md b/docs/framework/angular/reference/type-aliases/createmutatefunction.md index 4a8d6580dd..4d2fa67e15 100644 --- a/docs/framework/angular/reference/type-aliases/createmutatefunction.md +++ b/docs/framework/angular/reference/type-aliases/createmutatefunction.md @@ -6,7 +6,9 @@ title: CreateMutateFunction # Type Alias: CreateMutateFunction()\ ```ts -type CreateMutateFunction: (...args) => void; +type CreateMutateFunction = ( + ...args +) => void ``` ## Type Parameters @@ -21,7 +23,9 @@ type CreateMutateFunction: (...args) => voi ## Parameters -• ...**args**: `Parameters`\<`MutateFunction`\<`TData`, `TError`, `TVariables`, `TContext`\>\> +### args + +...`Parameters`\<`MutateFunction`\<`TData`, `TError`, `TVariables`, `TContext`\>\> ## Returns @@ -29,4 +33,4 @@ type CreateMutateFunction: (...args) => voi ## Defined in -[types.ts:176](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/types.ts#L176) +[types.ts:165](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L165) diff --git a/docs/framework/angular/reference/type-aliases/createmutationresult.md b/docs/framework/angular/reference/type-aliases/createmutationresult.md index 7f52e747fb..92ff8edd4c 100644 --- a/docs/framework/angular/reference/type-aliases/createmutationresult.md +++ b/docs/framework/angular/reference/type-aliases/createmutationresult.md @@ -6,7 +6,9 @@ title: CreateMutationResult # Type Alias: CreateMutationResult\ ```ts -type CreateMutationResult: BaseMutationNarrowing & MapToSignals>; +type CreateMutationResult = + BaseMutationNarrowing & + MapToSignals> ``` ## Type Parameters @@ -23,4 +25,4 @@ type CreateMutationResult: BaseMuta ## Defined in -[types.ts:292](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/types.ts#L292) +[types.ts:297](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L297) diff --git a/docs/framework/angular/reference/type-aliases/createqueryresult.md b/docs/framework/angular/reference/type-aliases/createqueryresult.md index 18b6952820..78ada66abc 100644 --- a/docs/framework/angular/reference/type-aliases/createqueryresult.md +++ b/docs/framework/angular/reference/type-aliases/createqueryresult.md @@ -6,7 +6,7 @@ title: CreateQueryResult # Type Alias: CreateQueryResult\ ```ts -type CreateQueryResult: CreateBaseQueryResult; +type CreateQueryResult = CreateBaseQueryResult ``` ## Type Parameters @@ -17,4 +17,4 @@ type CreateQueryResult: CreateBaseQueryResult; ## Defined in -[types.ts:126](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/types.ts#L126) +[types.ts:127](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L127) diff --git a/docs/framework/angular/reference/type-aliases/definedcreateinfinitequeryresult.md b/docs/framework/angular/reference/type-aliases/definedcreateinfinitequeryresult.md index 5107554d67..e49e629376 100644 --- a/docs/framework/angular/reference/type-aliases/definedcreateinfinitequeryresult.md +++ b/docs/framework/angular/reference/type-aliases/definedcreateinfinitequeryresult.md @@ -6,7 +6,11 @@ title: DefinedCreateInfiniteQueryResult # Type Alias: DefinedCreateInfiniteQueryResult\ ```ts -type DefinedCreateInfiniteQueryResult: MapToSignals; +type DefinedCreateInfiniteQueryResult< + TData, + TError, + TDefinedInfiniteQueryObserver, +> = MapToSignals ``` ## Type Parameters @@ -19,4 +23,4 @@ type DefinedCreateInfiniteQueryResult +# Type Alias: DefinedCreateQueryResult\ ```ts -type DefinedCreateQueryResult: MapToSignals; +type DefinedCreateQueryResult = BaseQueryNarrowing< + TData, + TError +> & + MapToSignals> ``` ## Type Parameters @@ -15,8 +19,8 @@ type DefinedCreateQueryResult: MapToSignal • **TError** = `DefaultError` -• **TDefinedQueryObserver** = `DefinedQueryObserverResult`\<`TData`, `TError`\> +• **TState** = `DefinedQueryObserverResult`\<`TData`, `TError`\> ## Defined in -[types.ts:134](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/types.ts#L134) +[types.ts:135](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L135) diff --git a/docs/framework/angular/reference/type-aliases/definedinitialdatainfiniteoptions.md b/docs/framework/angular/reference/type-aliases/definedinitialdatainfiniteoptions.md index ad63b14f44..07e74cb206 100644 --- a/docs/framework/angular/reference/type-aliases/definedinitialdatainfiniteoptions.md +++ b/docs/framework/angular/reference/type-aliases/definedinitialdatainfiniteoptions.md @@ -6,7 +6,21 @@ title: DefinedInitialDataInfiniteOptions # Type Alias: DefinedInitialDataInfiniteOptions\ ```ts -type DefinedInitialDataInfiniteOptions: CreateInfiniteQueryOptions & object; +type DefinedInitialDataInfiniteOptions< + TQueryFnData, + TError, + TData, + TQueryKey, + TPageParam, +> = CreateInfiniteQueryOptions< + TQueryFnData, + TError, + TData, + TQueryFnData, + TQueryKey, + TPageParam +> & + object ``` ## Type declaration @@ -14,7 +28,9 @@ type DefinedInitialDataInfiniteOptions> | () => NonUndefinedGuard>; +initialData: + | NonUndefinedGuard> +| () => NonUndefinedGuard>; ``` ## Type Parameters @@ -31,4 +47,4 @@ initialData: NonUndefinedGuard> | () => N ## Defined in -[infinite-query-options.ts:32](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/infinite-query-options.ts#L32) +[infinite-query-options.ts:32](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L32) diff --git a/docs/framework/angular/reference/type-aliases/definedinitialdataoptions.md b/docs/framework/angular/reference/type-aliases/definedinitialdataoptions.md index f4e8b6da59..9029c257ef 100644 --- a/docs/framework/angular/reference/type-aliases/definedinitialdataoptions.md +++ b/docs/framework/angular/reference/type-aliases/definedinitialdataoptions.md @@ -6,7 +6,8 @@ title: DefinedInitialDataOptions # Type Alias: DefinedInitialDataOptions\ ```ts -type DefinedInitialDataOptions: CreateQueryOptions & object; +type DefinedInitialDataOptions = + CreateQueryOptions & object ``` ## Type declaration @@ -14,7 +15,9 @@ type DefinedInitialDataOptions: CreateQu ### initialData ```ts -initialData: NonUndefinedGuard | () => NonUndefinedGuard; +initialData: + | NonUndefinedGuard +| () => NonUndefinedGuard; ``` ## Type Parameters @@ -29,4 +32,4 @@ initialData: NonUndefinedGuard | () => NonUndefinedGuard +``` + +A type alias that represents a feature which enables developer tools. +The type is used to describe the return value of the `withDevtools` function. + +## See + +[withDevtools](../functions/withdevtools.md) + +## Defined in + +[providers.ts:158](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L158) diff --git a/docs/framework/angular/reference/type-aliases/nonundefinedguard.md b/docs/framework/angular/reference/type-aliases/nonundefinedguard.md index f2673af9db..192f0ffce0 100644 --- a/docs/framework/angular/reference/type-aliases/nonundefinedguard.md +++ b/docs/framework/angular/reference/type-aliases/nonundefinedguard.md @@ -6,7 +6,7 @@ title: NonUndefinedGuard # Type Alias: NonUndefinedGuard\ ```ts -type NonUndefinedGuard: T extends undefined ? never : T; +type NonUndefinedGuard = T extends undefined ? never : T ``` ## Type Parameters @@ -15,4 +15,4 @@ type NonUndefinedGuard: T extends undefined ? never : T; ## Defined in -[types.ts:316](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/types.ts#L316) +[types.ts:315](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L315) diff --git a/docs/framework/angular/reference/type-aliases/queriesoptions.md b/docs/framework/angular/reference/type-aliases/queriesoptions.md index e21003d6f9..ccfcde6bb2 100644 --- a/docs/framework/angular/reference/type-aliases/queriesoptions.md +++ b/docs/framework/angular/reference/type-aliases/queriesoptions.md @@ -6,7 +6,33 @@ title: QueriesOptions # Type Alias: QueriesOptions\ ```ts -type QueriesOptions: TDepth["length"] extends MAXIMUM_DEPTH ? QueryObserverOptionsForCreateQueries[] : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetOptions] : T extends [infer Head, ...(infer Tail)] ? QueriesOptions<[...Tail], [...TResult, GetOptions], [...TDepth, 1]> : ReadonlyArray extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[]; +type QueriesOptions = TDepth['length'] extends MAXIMUM_DEPTH + ? QueryObserverOptionsForCreateQueries[] + : T extends [] + ? [] + : T extends [infer Head] + ? [...TResult, GetOptions] + : T extends [infer Head, ...infer Tail] + ? QueriesOptions< + [...Tail], + [...TResult, GetOptions], + [...TDepth, 1] + > + : ReadonlyArray extends T + ? T + : T extends QueryObserverOptionsForCreateQueries< + infer TQueryFnData, + infer TError, + infer TData, + infer TQueryKey + >[] + ? QueryObserverOptionsForCreateQueries< + TQueryFnData, + TError, + TData, + TQueryKey + >[] + : QueryObserverOptionsForCreateQueries[] ``` QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param @@ -21,4 +47,4 @@ QueriesOptions reducer recursively unwraps function arguments to infer/enforce t ## Defined in -[inject-queries.ts:108](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-queries.ts#L108) +[inject-queries.ts:118](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L118) diff --git a/docs/framework/angular/reference/type-aliases/queriesresults.md b/docs/framework/angular/reference/type-aliases/queriesresults.md index 7ff2e3ebd1..9459029976 100644 --- a/docs/framework/angular/reference/type-aliases/queriesresults.md +++ b/docs/framework/angular/reference/type-aliases/queriesresults.md @@ -6,7 +6,29 @@ title: QueriesResults # Type Alias: QueriesResults\ ```ts -type QueriesResults: TDepth["length"] extends MAXIMUM_DEPTH ? QueryObserverResult[] : T extends [] ? [] : T extends [infer Head] ? [...TResult, GetResults] : T extends [infer Head, ...(infer Tail)] ? QueriesResults<[...Tail], [...TResult, GetResults], [...TDepth, 1]> : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverResult[] : QueryObserverResult[]; +type QueriesResults = TDepth['length'] extends MAXIMUM_DEPTH + ? QueryObserverResult[] + : T extends [] + ? [] + : T extends [infer Head] + ? [...TResult, GetResults] + : T extends [infer Head, ...infer Tail] + ? QueriesResults< + [...Tail], + [...TResult, GetResults], + [...TDepth, 1] + > + : T extends QueryObserverOptionsForCreateQueries< + infer TQueryFnData, + infer TError, + infer TData, + any + >[] + ? QueryObserverResult< + unknown extends TData ? TQueryFnData : TData, + unknown extends TError ? DefaultError : TError + >[] + : QueryObserverResult[] ``` QueriesResults reducer recursively maps type param to results @@ -21,4 +43,4 @@ QueriesResults reducer recursively maps type param to results ## Defined in -[inject-queries.ts:151](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/inject-queries.ts#L151) +[inject-queries.ts:161](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L161) diff --git a/docs/framework/angular/reference/type-aliases/queryfeaturekind.md b/docs/framework/angular/reference/type-aliases/queryfeaturekind.md new file mode 100644 index 0000000000..17b762d27d --- /dev/null +++ b/docs/framework/angular/reference/type-aliases/queryfeaturekind.md @@ -0,0 +1,14 @@ +--- +id: QueryFeatureKind +title: QueryFeatureKind +--- + +# Type Alias: QueryFeatureKind + +```ts +type QueryFeatureKind = (typeof queryFeatures)[number] +``` + +## Defined in + +[providers.ts:353](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L353) diff --git a/docs/framework/angular/reference/type-aliases/queryfeatures.md b/docs/framework/angular/reference/type-aliases/queryfeatures.md new file mode 100644 index 0000000000..652285a226 --- /dev/null +++ b/docs/framework/angular/reference/type-aliases/queryfeatures.md @@ -0,0 +1,23 @@ +--- +id: QueryFeatures +title: QueryFeatures +--- + +# Type Alias: QueryFeatures + +```ts +type QueryFeatures = DeveloperToolsFeature +``` + +A type alias that represents all Query features available for use with `provideTanStackQuery`. +Features can be enabled by adding special functions to the `provideTanStackQuery` call. +See documentation for each symbol to find corresponding function name. See also `provideTanStackQuery` +documentation on how to use those functions. + +## See + +[provideTanStackQuery](../functions/providetanstackquery.md) + +## Defined in + +[providers.ts:349](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L349) diff --git a/docs/framework/angular/reference/type-aliases/undefinedinitialdatainfiniteoptions.md b/docs/framework/angular/reference/type-aliases/undefinedinitialdatainfiniteoptions.md index b1bb260cec..70dc60bd4c 100644 --- a/docs/framework/angular/reference/type-aliases/undefinedinitialdatainfiniteoptions.md +++ b/docs/framework/angular/reference/type-aliases/undefinedinitialdatainfiniteoptions.md @@ -6,7 +6,21 @@ title: UndefinedInitialDataInfiniteOptions # Type Alias: UndefinedInitialDataInfiniteOptions\ ```ts -type UndefinedInitialDataInfiniteOptions: CreateInfiniteQueryOptions & object; +type UndefinedInitialDataInfiniteOptions< + TQueryFnData, + TError, + TData, + TQueryKey, + TPageParam, +> = CreateInfiniteQueryOptions< + TQueryFnData, + TError, + TData, + TQueryFnData, + TQueryKey, + TPageParam +> & + object ``` ## Type declaration @@ -31,4 +45,4 @@ optional initialData: undefined; ## Defined in -[infinite-query-options.ts:12](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/infinite-query-options.ts#L12) +[infinite-query-options.ts:12](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L12) diff --git a/docs/framework/angular/reference/type-aliases/undefinedinitialdataoptions.md b/docs/framework/angular/reference/type-aliases/undefinedinitialdataoptions.md index bf64cf110e..c53fdf022c 100644 --- a/docs/framework/angular/reference/type-aliases/undefinedinitialdataoptions.md +++ b/docs/framework/angular/reference/type-aliases/undefinedinitialdataoptions.md @@ -6,7 +6,8 @@ title: UndefinedInitialDataOptions # Type Alias: UndefinedInitialDataOptions\ ```ts -type UndefinedInitialDataOptions: CreateQueryOptions & object; +type UndefinedInitialDataOptions = + CreateQueryOptions & object ``` ## Type declaration @@ -14,7 +15,7 @@ type UndefinedInitialDataOptions: Create ### initialData? ```ts -optional initialData: undefined; +optional initialData: InitialDataFunction>; ``` ## Type Parameters @@ -29,4 +30,4 @@ optional initialData: undefined; ## Defined in -[query-options.ts:7](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/angular-query-experimental/src/query-options.ts#L7) +[query-options.ts:12](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L12) diff --git a/docs/framework/angular/reference/variables/queryfeatures.md b/docs/framework/angular/reference/variables/queryfeatures.md new file mode 100644 index 0000000000..82915e99ae --- /dev/null +++ b/docs/framework/angular/reference/variables/queryfeatures.md @@ -0,0 +1,14 @@ +--- +id: queryFeatures +title: queryFeatures +--- + +# Variable: queryFeatures + +```ts +const queryFeatures: readonly ['DeveloperTools'] +``` + +## Defined in + +[providers.ts:351](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L351) diff --git a/docs/framework/svelte/reference/classes/hydrationboundary.md b/docs/framework/svelte/reference/classes/hydrationboundary.md index 9690e1a6d6..c4e39e2596 100644 --- a/docs/framework/svelte/reference/classes/hydrationboundary.md +++ b/docs/framework/svelte/reference/classes/hydrationboundary.md @@ -58,7 +58,9 @@ new HydrationBoundary(options): HydrationBoundary +##### options + +`ComponentConstructorOptions`\<`Props`\> #### Returns @@ -70,7 +72,7 @@ new HydrationBoundary(options): HydrationBoundary(type, callback): () => void #### Parameters -• **type**: `K` +##### type + +`K` -• **callback**: `undefined` \| `null` \| (`e`) => `void` +##### callback + +`undefined` | `null` | (`e`) => `void` #### Returns @@ -247,7 +253,7 @@ $on(type, callback): () => void #### Defined in -node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:113 +node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:113 --- @@ -259,7 +265,9 @@ $set(props): void #### Parameters -• **props**: `Partial`\<`Props`\> +##### props + +`Partial`\<`Props`\> #### Returns @@ -271,4 +279,4 @@ $set(props): void #### Defined in -node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:115 +node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:115 diff --git a/docs/framework/svelte/reference/functions/createinfinitequery.md b/docs/framework/svelte/reference/functions/createinfinitequery.md index a067f73775..144f702db9 100644 --- a/docs/framework/svelte/reference/functions/createinfinitequery.md +++ b/docs/framework/svelte/reference/functions/createinfinitequery.md @@ -23,15 +23,19 @@ function createInfiniteQuery< • **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] • **TPageParam** = `unknown` ## Parameters -• **options**: [`StoreOrVal`](../type-aliases/storeorval.md)\<[`CreateInfiniteQueryOptions`](../type-aliases/createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\>\> +### options -• **queryClient?**: `QueryClient` +[`StoreOrVal`](../type-aliases/storeorval.md)\<[`CreateInfiniteQueryOptions`](../type-aliases/createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\>\> + +### queryClient? + +`QueryClient` ## Returns @@ -39,4 +43,4 @@ function createInfiniteQuery< ## Defined in -[packages/svelte-query/src/createInfiniteQuery.ts:16](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/createInfiniteQuery.ts#L16) +[packages/svelte-query/src/createInfiniteQuery.ts:16](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createInfiniteQuery.ts#L16) diff --git a/docs/framework/svelte/reference/functions/createmutation.md b/docs/framework/svelte/reference/functions/createmutation.md index ad11e8c6e9..a9a4edfba1 100644 --- a/docs/framework/svelte/reference/functions/createmutation.md +++ b/docs/framework/svelte/reference/functions/createmutation.md @@ -24,9 +24,13 @@ function createMutation( ## Parameters -• **options**: [`StoreOrVal`](../type-aliases/storeorval.md)\<[`CreateMutationOptions`](../type-aliases/createmutationoptions.md)\<`TData`, `TError`, `TVariables`, `TContext`\>\> +### options -• **queryClient?**: `QueryClient` +[`StoreOrVal`](../type-aliases/storeorval.md)\<[`CreateMutationOptions`](../type-aliases/createmutationoptions.md)\<`TData`, `TError`, `TVariables`, `TContext`\>\> + +### queryClient? + +`QueryClient` ## Returns @@ -34,4 +38,4 @@ function createMutation( ## Defined in -[packages/svelte-query/src/createMutation.ts:13](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/createMutation.ts#L13) +[packages/svelte-query/src/createMutation.ts:13](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createMutation.ts#L13) diff --git a/docs/framework/svelte/reference/functions/createqueries.md b/docs/framework/svelte/reference/functions/createqueries.md index 90a77b2a1c..eb29cc7857 100644 --- a/docs/framework/svelte/reference/functions/createqueries.md +++ b/docs/framework/svelte/reference/functions/createqueries.md @@ -20,13 +20,19 @@ function createQueries( ## Parameters -• **\_\_namedParameters** +### \_\_namedParameters -• **\_\_namedParameters.combine?** +#### combine -• **\_\_namedParameters.queries?**: [`StoreOrVal`](../type-aliases/storeorval.md)\<[`...(T extends [] ? [] : T extends [Head] ? [GetQueryObserverOptionsForCreateQueries] : T extends [Head, ...Tails[]] ? [...Tails[]] extends [] ? [] : [...Tails[]] extends [Head] ? [GetQueryObserverOptionsForCreateQueries, GetQueryObserverOptionsForCreateQueries] : [...Tails[]] extends [Head, ...Tails[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[])[]`]\> +(`result`) => `TCombinedResult` -• **queryClient?**: `QueryClient` +#### queries + +[`StoreOrVal`](../type-aliases/storeorval.md)\<[`...(T extends [] ? [] : T extends [Head] ? [GetQueryObserverOptionsForCreateQueries] : T extends [Head, ...Tails[]] ? [...Tails[]] extends [] ? [] : [...Tails[]] extends [Head] ? [GetQueryObserverOptionsForCreateQueries, GetQueryObserverOptionsForCreateQueries] : [...Tails[]] extends [Head, ...Tails[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[])[]`]\> + +### queryClient? + +`QueryClient` ## Returns @@ -34,4 +40,4 @@ function createQueries( ## Defined in -[packages/svelte-query/src/createQueries.ts:205](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/createQueries.ts#L205) +[packages/svelte-query/src/createQueries.ts:205](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQueries.ts#L205) diff --git a/docs/framework/svelte/reference/functions/createquery.md b/docs/framework/svelte/reference/functions/createquery.md index 605fbc1f99..67a02a2127 100644 --- a/docs/framework/svelte/reference/functions/createquery.md +++ b/docs/framework/svelte/reference/functions/createquery.md @@ -5,7 +5,7 @@ title: createQuery # Function: createQuery() -## createQuery(options, queryClient) +## Call Signature ```ts function createQuery( @@ -22,13 +22,17 @@ function createQuery( • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] ### Parameters -• **options**: [`StoreOrVal`](../type-aliases/storeorval.md)\<[`DefinedInitialDataOptions`](../type-aliases/definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\> +#### options -• **queryClient?**: `QueryClient` +[`StoreOrVal`](../type-aliases/storeorval.md)\<[`DefinedInitialDataOptions`](../type-aliases/definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\> + +#### queryClient? + +`QueryClient` ### Returns @@ -36,9 +40,9 @@ function createQuery( ### Defined in -[packages/svelte-query/src/createQuery.ts:15](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/createQuery.ts#L15) +[packages/svelte-query/src/createQuery.ts:15](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQuery.ts#L15) -## createQuery(options, queryClient) +## Call Signature ```ts function createQuery( @@ -55,13 +59,17 @@ function createQuery( • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] ### Parameters -• **options**: [`StoreOrVal`](../type-aliases/storeorval.md)\<[`UndefinedInitialDataOptions`](../type-aliases/undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\> +#### options + +[`StoreOrVal`](../type-aliases/storeorval.md)\<[`UndefinedInitialDataOptions`](../type-aliases/undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\> -• **queryClient?**: `QueryClient` +#### queryClient? + +`QueryClient` ### Returns @@ -69,9 +77,9 @@ function createQuery( ### Defined in -[packages/svelte-query/src/createQuery.ts:27](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/createQuery.ts#L27) +[packages/svelte-query/src/createQuery.ts:27](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQuery.ts#L27) -## createQuery(options, queryClient) +## Call Signature ```ts function createQuery( @@ -88,13 +96,17 @@ function createQuery( • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] ### Parameters -• **options**: [`StoreOrVal`](../type-aliases/storeorval.md)\<[`CreateQueryOptions`](../type-aliases/createqueryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\> +#### options + +[`StoreOrVal`](../type-aliases/storeorval.md)\<[`CreateQueryOptions`](../type-aliases/createqueryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\>\> + +#### queryClient? -• **queryClient?**: `QueryClient` +`QueryClient` ### Returns @@ -102,4 +114,4 @@ function createQuery( ### Defined in -[packages/svelte-query/src/createQuery.ts:39](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/createQuery.ts#L39) +[packages/svelte-query/src/createQuery.ts:39](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQuery.ts#L39) diff --git a/docs/framework/svelte/reference/functions/getisrestoringcontext.md b/docs/framework/svelte/reference/functions/getisrestoringcontext.md index 22aa563796..923a433775 100644 --- a/docs/framework/svelte/reference/functions/getisrestoringcontext.md +++ b/docs/framework/svelte/reference/functions/getisrestoringcontext.md @@ -17,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/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/context.ts#L28) +[packages/svelte-query/src/context.ts:28](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/context.ts#L28) diff --git a/docs/framework/svelte/reference/functions/getqueryclientcontext.md b/docs/framework/svelte/reference/functions/getqueryclientcontext.md index f311a473f6..8d34ab100c 100644 --- a/docs/framework/svelte/reference/functions/getqueryclientcontext.md +++ b/docs/framework/svelte/reference/functions/getqueryclientcontext.md @@ -17,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/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/context.ts#L9) +[packages/svelte-query/src/context.ts:9](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/context.ts#L9) diff --git a/docs/framework/svelte/reference/functions/infinitequeryoptions.md b/docs/framework/svelte/reference/functions/infinitequeryoptions.md index 3e9a0c5b4b..bbba66452f 100644 --- a/docs/framework/svelte/reference/functions/infinitequeryoptions.md +++ b/docs/framework/svelte/reference/functions/infinitequeryoptions.md @@ -32,13 +32,15 @@ function infiniteQueryOptions< • **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] • **TPageParam** = `unknown` ## Parameters -• **options**: [`CreateInfiniteQueryOptions`](../type-aliases/createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\> +### options + +[`CreateInfiniteQueryOptions`](../type-aliases/createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\> ## Returns @@ -46,4 +48,4 @@ function infiniteQueryOptions< ## Defined in -[packages/svelte-query/src/infiniteQueryOptions.ts:4](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/infiniteQueryOptions.ts#L4) +[packages/svelte-query/src/infiniteQueryOptions.ts:4](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/infiniteQueryOptions.ts#L4) diff --git a/docs/framework/svelte/reference/functions/queryoptions.md b/docs/framework/svelte/reference/functions/queryoptions.md index d499202669..a10f4bcf92 100644 --- a/docs/framework/svelte/reference/functions/queryoptions.md +++ b/docs/framework/svelte/reference/functions/queryoptions.md @@ -5,7 +5,7 @@ title: queryOptions # Function: queryOptions() -## queryOptions(options) +## Call Signature ```ts function queryOptions( @@ -21,11 +21,13 @@ function queryOptions( • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] ### Parameters -• **options**: [`DefinedInitialDataOptions`](../type-aliases/definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> +#### options + +[`DefinedInitialDataOptions`](../type-aliases/definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> ### Returns @@ -33,9 +35,9 @@ function queryOptions( ### Defined in -[packages/svelte-query/src/queryOptions.ts:26](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/queryOptions.ts#L26) +[packages/svelte-query/src/queryOptions.ts:31](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L31) -## queryOptions(options) +## Call Signature ```ts function queryOptions( @@ -51,11 +53,13 @@ function queryOptions( • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] ### Parameters -• **options**: [`UndefinedInitialDataOptions`](../type-aliases/undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> +#### options + +[`UndefinedInitialDataOptions`](../type-aliases/undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> ### Returns @@ -63,4 +67,4 @@ function queryOptions( ### Defined in -[packages/svelte-query/src/queryOptions.ts:37](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/queryOptions.ts#L37) +[packages/svelte-query/src/queryOptions.ts:42](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L42) diff --git a/docs/framework/svelte/reference/functions/setisrestoringcontext.md b/docs/framework/svelte/reference/functions/setisrestoringcontext.md index 0ab290bf09..95555d77cb 100644 --- a/docs/framework/svelte/reference/functions/setisrestoringcontext.md +++ b/docs/framework/svelte/reference/functions/setisrestoringcontext.md @@ -13,7 +13,9 @@ Sets a `isRestoring` on Svelte's context ## Parameters -• **isRestoring**: `Readable`\<`boolean`\> +### isRestoring + +`Readable`\<`boolean`\> ## Returns @@ -21,4 +23,4 @@ Sets a `isRestoring` on Svelte's context ## Defined in -[packages/svelte-query/src/context.ts:40](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/context.ts#L40) +[packages/svelte-query/src/context.ts:40](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/context.ts#L40) diff --git a/docs/framework/svelte/reference/functions/setqueryclientcontext.md b/docs/framework/svelte/reference/functions/setqueryclientcontext.md index 4a4ce300b2..22caba70a8 100644 --- a/docs/framework/svelte/reference/functions/setqueryclientcontext.md +++ b/docs/framework/svelte/reference/functions/setqueryclientcontext.md @@ -13,7 +13,9 @@ Sets a QueryClient on Svelte's context ## Parameters -• **client**: `QueryClient` +### client + +`QueryClient` ## Returns @@ -21,4 +23,4 @@ Sets a QueryClient on Svelte's context ## Defined in -[packages/svelte-query/src/context.ts:21](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/context.ts#L21) +[packages/svelte-query/src/context.ts:21](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/context.ts#L21) diff --git a/docs/framework/svelte/reference/functions/usehydrate.md b/docs/framework/svelte/reference/functions/usehydrate.md index c4abb97e0d..f85bde0c3e 100644 --- a/docs/framework/svelte/reference/functions/usehydrate.md +++ b/docs/framework/svelte/reference/functions/usehydrate.md @@ -11,11 +11,17 @@ function useHydrate(state?, options?, queryClient?): void ## Parameters -• **state?**: `unknown` +### state? -• **options?**: `HydrateOptions` +`unknown` -• **queryClient?**: `QueryClient` +### options? + +`HydrateOptions` + +### queryClient? + +`QueryClient` ## Returns @@ -23,4 +29,4 @@ function useHydrate(state?, options?, queryClient?): void ## Defined in -[packages/svelte-query/src/useHydrate.ts:8](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/useHydrate.ts#L8) +[packages/svelte-query/src/useHydrate.ts:5](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useHydrate.ts#L5) diff --git a/docs/framework/svelte/reference/functions/useisfetching.md b/docs/framework/svelte/reference/functions/useisfetching.md index fbfd0d55bf..8796d61bef 100644 --- a/docs/framework/svelte/reference/functions/useisfetching.md +++ b/docs/framework/svelte/reference/functions/useisfetching.md @@ -11,9 +11,13 @@ function useIsFetching(filters?, queryClient?): Readable ## Parameters -• **filters?**: `QueryFilters` +### filters? -• **queryClient?**: `QueryClient` +`QueryFilters`\<`unknown`, `Error`, `unknown`, readonly `unknown`[]\> + +### queryClient? + +`QueryClient` ## Returns @@ -21,4 +25,4 @@ function useIsFetching(filters?, queryClient?): Readable ## Defined in -[packages/svelte-query/src/useIsFetching.ts:10](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/useIsFetching.ts#L10) +[packages/svelte-query/src/useIsFetching.ts:7](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useIsFetching.ts#L7) diff --git a/docs/framework/svelte/reference/functions/useismutating.md b/docs/framework/svelte/reference/functions/useismutating.md index 2e05ae3218..a2773004ab 100644 --- a/docs/framework/svelte/reference/functions/useismutating.md +++ b/docs/framework/svelte/reference/functions/useismutating.md @@ -11,9 +11,13 @@ function useIsMutating(filters?, queryClient?): Readable ## Parameters -• **filters?**: `MutationFilters` +### filters? -• **queryClient?**: `QueryClient` +`MutationFilters`\<`unknown`, `Error`, `unknown`, `unknown`\> + +### queryClient? + +`QueryClient` ## Returns @@ -21,4 +25,4 @@ function useIsMutating(filters?, queryClient?): Readable ## Defined in -[packages/svelte-query/src/useIsMutating.ts:10](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/useIsMutating.ts#L10) +[packages/svelte-query/src/useIsMutating.ts:7](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useIsMutating.ts#L7) diff --git a/docs/framework/svelte/reference/functions/useisrestoring.md b/docs/framework/svelte/reference/functions/useisrestoring.md index 4cd72cfab8..5bebc77087 100644 --- a/docs/framework/svelte/reference/functions/useisrestoring.md +++ b/docs/framework/svelte/reference/functions/useisrestoring.md @@ -15,4 +15,4 @@ function useIsRestoring(): Readable ## Defined in -[packages/svelte-query/src/useIsRestoring.ts:4](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/useIsRestoring.ts#L4) +[packages/svelte-query/src/useIsRestoring.ts:4](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useIsRestoring.ts#L4) diff --git a/docs/framework/svelte/reference/functions/usemutationstate.md b/docs/framework/svelte/reference/functions/usemutationstate.md index 83de5455e7..f335bebf99 100644 --- a/docs/framework/svelte/reference/functions/usemutationstate.md +++ b/docs/framework/svelte/reference/functions/usemutationstate.md @@ -15,9 +15,13 @@ function useMutationState(options, queryClient?): Readable ## Parameters -• **options**: [`MutationStateOptions`](../type-aliases/mutationstateoptions.md)\<`TResult`\> = `{}` +### options -• **queryClient?**: `QueryClient` +[`MutationStateOptions`](../type-aliases/mutationstateoptions.md)\<`TResult`\> = `{}` + +### queryClient? + +`QueryClient` ## Returns @@ -25,4 +29,4 @@ function useMutationState(options, queryClient?): Readable ## Defined in -[packages/svelte-query/src/useMutationState.ts:24](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/useMutationState.ts#L24) +[packages/svelte-query/src/useMutationState.ts:24](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useMutationState.ts#L24) diff --git a/docs/framework/svelte/reference/functions/usequeryclient.md b/docs/framework/svelte/reference/functions/usequeryclient.md index e6f169c143..2a962408ca 100644 --- a/docs/framework/svelte/reference/functions/usequeryclient.md +++ b/docs/framework/svelte/reference/functions/usequeryclient.md @@ -11,7 +11,9 @@ function useQueryClient(queryClient?): QueryClient ## Parameters -• **queryClient?**: `QueryClient` +### queryClient? + +`QueryClient` ## Returns @@ -19,4 +21,4 @@ function useQueryClient(queryClient?): QueryClient ## Defined in -[packages/svelte-query/src/useQueryClient.ts:4](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/useQueryClient.ts#L4) +[packages/svelte-query/src/useQueryClient.ts:4](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useQueryClient.ts#L4) diff --git a/docs/framework/svelte/reference/type-aliases/createbasemutationresult.md b/docs/framework/svelte/reference/type-aliases/createbasemutationresult.md index 750c599d80..9d51cbc3b2 100644 --- a/docs/framework/svelte/reference/type-aliases/createbasemutationresult.md +++ b/docs/framework/svelte/reference/type-aliases/createbasemutationresult.md @@ -6,7 +6,13 @@ title: CreateBaseMutationResult # Type Alias: CreateBaseMutationResult\ ```ts -type CreateBaseMutationResult: Override, object> & object; +type CreateBaseMutationResult = Override< + MutationObserverResult, + { + mutate: CreateMutateFunction + } +> & + object ``` ## Type declaration @@ -29,4 +35,4 @@ mutateAsync: CreateMutateAsyncFunction ## Defined in -[packages/svelte-query/src/types.ts:113](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/types.ts#L113) +[packages/svelte-query/src/types.ts:114](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L114) diff --git a/docs/framework/svelte/reference/type-aliases/createbasequeryoptions.md b/docs/framework/svelte/reference/type-aliases/createbasequeryoptions.md index 8a1967c124..17aa6e9ed3 100644 --- a/docs/framework/svelte/reference/type-aliases/createbasequeryoptions.md +++ b/docs/framework/svelte/reference/type-aliases/createbasequeryoptions.md @@ -6,7 +6,13 @@ title: CreateBaseQueryOptions # Type Alias: CreateBaseQueryOptions\ ```ts -type CreateBaseQueryOptions: QueryObserverOptions; +type CreateBaseQueryOptions< + TQueryFnData, + TError, + TData, + TQueryData, + TQueryKey, +> = QueryObserverOptions ``` Options for createBaseQuery @@ -25,4 +31,4 @@ Options for createBaseQuery ## Defined in -[packages/svelte-query/src/types.ts:23](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/types.ts#L23) +[packages/svelte-query/src/types.ts:24](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L24) diff --git a/docs/framework/svelte/reference/type-aliases/createbasequeryresult.md b/docs/framework/svelte/reference/type-aliases/createbasequeryresult.md index 01d19e64ea..67f649cd71 100644 --- a/docs/framework/svelte/reference/type-aliases/createbasequeryresult.md +++ b/docs/framework/svelte/reference/type-aliases/createbasequeryresult.md @@ -6,7 +6,9 @@ title: CreateBaseQueryResult # Type Alias: CreateBaseQueryResult\ ```ts -type CreateBaseQueryResult: Readable>; +type CreateBaseQueryResult = Readable< + QueryObserverResult +> ``` Result from createBaseQuery @@ -19,4 +21,4 @@ Result from createBaseQuery ## Defined in -[packages/svelte-query/src/types.ts:32](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/types.ts#L32) +[packages/svelte-query/src/types.ts:33](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L33) diff --git a/docs/framework/svelte/reference/type-aliases/createinfinitequeryoptions.md b/docs/framework/svelte/reference/type-aliases/createinfinitequeryoptions.md index e248532a85..674fe7801a 100644 --- a/docs/framework/svelte/reference/type-aliases/createinfinitequeryoptions.md +++ b/docs/framework/svelte/reference/type-aliases/createinfinitequeryoptions.md @@ -6,7 +6,21 @@ title: CreateInfiniteQueryOptions # Type Alias: CreateInfiniteQueryOptions\ ```ts -type CreateInfiniteQueryOptions: InfiniteQueryObserverOptions; +type CreateInfiniteQueryOptions< + TQueryFnData, + TError, + TData, + TQueryData, + TQueryKey, + TPageParam, +> = InfiniteQueryObserverOptions< + TQueryFnData, + TError, + TData, + TQueryData, + TQueryKey, + TPageParam +> ``` Options for createInfiniteQuery @@ -27,4 +41,4 @@ Options for createInfiniteQuery ## Defined in -[packages/svelte-query/src/types.ts:52](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/types.ts#L52) +[packages/svelte-query/src/types.ts:53](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L53) diff --git a/docs/framework/svelte/reference/type-aliases/createinfinitequeryresult.md b/docs/framework/svelte/reference/type-aliases/createinfinitequeryresult.md index 4027388adc..07ec8c90ce 100644 --- a/docs/framework/svelte/reference/type-aliases/createinfinitequeryresult.md +++ b/docs/framework/svelte/reference/type-aliases/createinfinitequeryresult.md @@ -6,7 +6,9 @@ title: CreateInfiniteQueryResult # Type Alias: CreateInfiniteQueryResult\ ```ts -type CreateInfiniteQueryResult: Readable>; +type CreateInfiniteQueryResult = Readable< + InfiniteQueryObserverResult +> ``` Result from createInfiniteQuery @@ -19,4 +21,4 @@ Result from createInfiniteQuery ## Defined in -[packages/svelte-query/src/types.ts:69](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/types.ts#L69) +[packages/svelte-query/src/types.ts:70](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L70) diff --git a/docs/framework/svelte/reference/type-aliases/createmutateasyncfunction.md b/docs/framework/svelte/reference/type-aliases/createmutateasyncfunction.md index 01567a772e..31162afcd4 100644 --- a/docs/framework/svelte/reference/type-aliases/createmutateasyncfunction.md +++ b/docs/framework/svelte/reference/type-aliases/createmutateasyncfunction.md @@ -6,7 +6,8 @@ title: CreateMutateAsyncFunction # Type Alias: CreateMutateAsyncFunction\ ```ts -type CreateMutateAsyncFunction: MutateFunction; +type CreateMutateAsyncFunction = + MutateFunction ``` ## Type Parameters @@ -21,4 +22,4 @@ type CreateMutateAsyncFunction: MutateFunct ## Defined in -[packages/svelte-query/src/types.ts:106](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/types.ts#L106) +[packages/svelte-query/src/types.ts:107](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L107) diff --git a/docs/framework/svelte/reference/type-aliases/createmutatefunction.md b/docs/framework/svelte/reference/type-aliases/createmutatefunction.md index 18230411ef..277affff10 100644 --- a/docs/framework/svelte/reference/type-aliases/createmutatefunction.md +++ b/docs/framework/svelte/reference/type-aliases/createmutatefunction.md @@ -6,7 +6,9 @@ title: CreateMutateFunction # Type Alias: CreateMutateFunction()\ ```ts -type CreateMutateFunction: (...args) => void; +type CreateMutateFunction = ( + ...args +) => void ``` ## Type Parameters @@ -21,7 +23,9 @@ type CreateMutateFunction: (...args) => voi ## Parameters -• ...**args**: `Parameters`\<`MutateFunction`\<`TData`, `TError`, `TVariables`, `TContext`\>\> +### args + +...`Parameters`\<`MutateFunction`\<`TData`, `TError`, `TVariables`, `TContext`\>\> ## Returns @@ -29,4 +33,4 @@ type CreateMutateFunction: (...args) => voi ## Defined in -[packages/svelte-query/src/types.ts:97](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/types.ts#L97) +[packages/svelte-query/src/types.ts:98](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L98) diff --git a/docs/framework/svelte/reference/type-aliases/createmutationoptions.md b/docs/framework/svelte/reference/type-aliases/createmutationoptions.md index c091bb44db..6f1fd3ab96 100644 --- a/docs/framework/svelte/reference/type-aliases/createmutationoptions.md +++ b/docs/framework/svelte/reference/type-aliases/createmutationoptions.md @@ -6,7 +6,10 @@ title: CreateMutationOptions # Type Alias: CreateMutationOptions\ ```ts -type CreateMutationOptions: OmitKeyof, "_defaulted">; +type CreateMutationOptions = OmitKeyof< + MutationObserverOptions, + '_defaulted' +> ``` Options for createMutation @@ -23,4 +26,4 @@ Options for createMutation ## Defined in -[packages/svelte-query/src/types.ts:87](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/types.ts#L87) +[packages/svelte-query/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L88) diff --git a/docs/framework/svelte/reference/type-aliases/createmutationresult.md b/docs/framework/svelte/reference/type-aliases/createmutationresult.md index f0cc9f62c7..9e6fae8dbb 100644 --- a/docs/framework/svelte/reference/type-aliases/createmutationresult.md +++ b/docs/framework/svelte/reference/type-aliases/createmutationresult.md @@ -6,7 +6,9 @@ title: CreateMutationResult # Type Alias: CreateMutationResult\ ```ts -type CreateMutationResult: Readable>; +type CreateMutationResult = Readable< + CreateBaseMutationResult +> ``` Result from createMutation @@ -23,4 +25,4 @@ Result from createMutation ## Defined in -[packages/svelte-query/src/types.ts:126](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/types.ts#L126) +[packages/svelte-query/src/types.ts:127](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L127) diff --git a/docs/framework/svelte/reference/type-aliases/createqueryoptions.md b/docs/framework/svelte/reference/type-aliases/createqueryoptions.md index 0f24070104..dd46abd078 100644 --- a/docs/framework/svelte/reference/type-aliases/createqueryoptions.md +++ b/docs/framework/svelte/reference/type-aliases/createqueryoptions.md @@ -6,7 +6,8 @@ title: CreateQueryOptions # Type Alias: CreateQueryOptions\ ```ts -type CreateQueryOptions: CreateBaseQueryOptions; +type CreateQueryOptions = + CreateBaseQueryOptions ``` Options for createQuery @@ -23,4 +24,4 @@ Options for createQuery ## Defined in -[packages/svelte-query/src/types.ts:38](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/types.ts#L38) +[packages/svelte-query/src/types.ts:39](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L39) diff --git a/docs/framework/svelte/reference/type-aliases/createqueryresult.md b/docs/framework/svelte/reference/type-aliases/createqueryresult.md index f57f253fea..5be421869b 100644 --- a/docs/framework/svelte/reference/type-aliases/createqueryresult.md +++ b/docs/framework/svelte/reference/type-aliases/createqueryresult.md @@ -6,7 +6,7 @@ title: CreateQueryResult # Type Alias: CreateQueryResult\ ```ts -type CreateQueryResult: CreateBaseQueryResult; +type CreateQueryResult = CreateBaseQueryResult ``` Result from createQuery @@ -19,4 +19,4 @@ Result from createQuery ## Defined in -[packages/svelte-query/src/types.ts:46](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/types.ts#L46) +[packages/svelte-query/src/types.ts:47](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L47) diff --git a/docs/framework/svelte/reference/type-aliases/definedcreatebasequeryresult.md b/docs/framework/svelte/reference/type-aliases/definedcreatebasequeryresult.md index 1c4afda88a..abdf5c35af 100644 --- a/docs/framework/svelte/reference/type-aliases/definedcreatebasequeryresult.md +++ b/docs/framework/svelte/reference/type-aliases/definedcreatebasequeryresult.md @@ -6,7 +6,9 @@ title: DefinedCreateBaseQueryResult # Type Alias: DefinedCreateBaseQueryResult\ ```ts -type DefinedCreateBaseQueryResult: Readable>; +type DefinedCreateBaseQueryResult = Readable< + DefinedQueryObserverResult +> ``` Options for createBaseQuery with initialData @@ -19,4 +21,4 @@ Options for createBaseQuery with initialData ## Defined in -[packages/svelte-query/src/types.ts:75](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/types.ts#L75) +[packages/svelte-query/src/types.ts:76](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L76) diff --git a/docs/framework/svelte/reference/type-aliases/definedcreatequeryresult.md b/docs/framework/svelte/reference/type-aliases/definedcreatequeryresult.md index 7f360dc680..aef2cc962e 100644 --- a/docs/framework/svelte/reference/type-aliases/definedcreatequeryresult.md +++ b/docs/framework/svelte/reference/type-aliases/definedcreatequeryresult.md @@ -6,7 +6,10 @@ title: DefinedCreateQueryResult # Type Alias: DefinedCreateQueryResult\ ```ts -type DefinedCreateQueryResult: DefinedCreateBaseQueryResult; +type DefinedCreateQueryResult = DefinedCreateBaseQueryResult< + TData, + TError +> ``` Options for createQuery with initialData @@ -19,4 +22,4 @@ Options for createQuery with initialData ## Defined in -[packages/svelte-query/src/types.ts:81](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/types.ts#L81) +[packages/svelte-query/src/types.ts:82](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L82) diff --git a/docs/framework/svelte/reference/type-aliases/definedinitialdataoptions.md b/docs/framework/svelte/reference/type-aliases/definedinitialdataoptions.md index 95a0613537..dc2066626f 100644 --- a/docs/framework/svelte/reference/type-aliases/definedinitialdataoptions.md +++ b/docs/framework/svelte/reference/type-aliases/definedinitialdataoptions.md @@ -6,7 +6,8 @@ title: DefinedInitialDataOptions # Type Alias: DefinedInitialDataOptions\ ```ts -type DefinedInitialDataOptions: CreateQueryOptions & object; +type DefinedInitialDataOptions = + CreateQueryOptions & object ``` ## Type declaration @@ -14,7 +15,9 @@ type DefinedInitialDataOptions: CreateQu ### initialData ```ts -initialData: NonUndefinedGuard | () => NonUndefinedGuard; +initialData: + | NonUndefinedGuard +| () => NonUndefinedGuard; ``` ## Type Parameters @@ -29,4 +32,4 @@ initialData: NonUndefinedGuard | () => NonUndefinedGuard ```ts -type MutationStateOptions: object; +type MutationStateOptions = object ``` Options for useMutationState @@ -31,7 +31,9 @@ optional select: (mutation) => TResult; #### Parameters -• **mutation**: `Mutation`\<`unknown`, `DefaultError`, `unknown`, `unknown`\> +##### mutation + +`Mutation`\<`unknown`, `DefaultError`, `unknown`, `unknown`\> #### Returns @@ -39,4 +41,4 @@ optional select: (mutation) => TResult; ## Defined in -[packages/svelte-query/src/types.ts:140](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/types.ts#L140) +[packages/svelte-query/src/types.ts:135](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L135) diff --git a/docs/framework/svelte/reference/type-aliases/queriesoptions.md b/docs/framework/svelte/reference/type-aliases/queriesoptions.md index 0f6fe1097b..926c8abbdd 100644 --- a/docs/framework/svelte/reference/type-aliases/queriesoptions.md +++ b/docs/framework/svelte/reference/type-aliases/queriesoptions.md @@ -6,7 +6,34 @@ title: QueriesOptions # Type Alias: QueriesOptions\ ```ts -type QueriesOptions: TDepth["length"] extends MAXIMUM_DEPTH ? QueryObserverOptionsForCreateQueries[] : T extends [] ? [] : T extends [infer Head] ? [...TResults, GetQueryObserverOptionsForCreateQueries] : T extends [infer Head, ...(infer Tails)] ? QueriesOptions<[...Tails], [...TResults, GetQueryObserverOptionsForCreateQueries], [...TDepth, 1]> : ReadonlyArray extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[]; +type QueriesOptions = + TDepth['length'] extends MAXIMUM_DEPTH + ? QueryObserverOptionsForCreateQueries[] + : T extends [] + ? [] + : T extends [infer Head] + ? [...TResults, GetQueryObserverOptionsForCreateQueries] + : T extends [infer Head, ...infer Tails] + ? QueriesOptions< + [...Tails], + [...TResults, GetQueryObserverOptionsForCreateQueries], + [...TDepth, 1] + > + : ReadonlyArray extends T + ? T + : T extends QueryObserverOptionsForCreateQueries< + infer TQueryFnData, + infer TError, + infer TData, + infer TQueryKey + >[] + ? QueryObserverOptionsForCreateQueries< + TQueryFnData, + TError, + TData, + TQueryKey + >[] + : QueryObserverOptionsForCreateQueries[] ``` QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param @@ -21,4 +48,4 @@ QueriesOptions reducer recursively unwraps function arguments to infer/enforce t ## Defined in -[packages/svelte-query/src/createQueries.ts:129](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/createQueries.ts#L129) +[packages/svelte-query/src/createQueries.ts:129](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQueries.ts#L129) diff --git a/docs/framework/svelte/reference/type-aliases/queriesresults.md b/docs/framework/svelte/reference/type-aliases/queriesresults.md index 7ce41d896f..248bfb39a9 100644 --- a/docs/framework/svelte/reference/type-aliases/queriesresults.md +++ b/docs/framework/svelte/reference/type-aliases/queriesresults.md @@ -6,7 +6,30 @@ title: QueriesResults # Type Alias: QueriesResults\ ```ts -type QueriesResults: TDepth["length"] extends MAXIMUM_DEPTH ? QueryObserverResult[] : T extends [] ? [] : T extends [infer Head] ? [...TResults, GetCreateQueryResult] : T extends [infer Head, ...(infer Tails)] ? QueriesResults<[...Tails], [...TResults, GetCreateQueryResult], [...TDepth, 1]> : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverResult[] : QueryObserverResult[]; +type QueriesResults = + TDepth['length'] extends MAXIMUM_DEPTH + ? QueryObserverResult[] + : T extends [] + ? [] + : T extends [infer Head] + ? [...TResults, GetCreateQueryResult] + : T extends [infer Head, ...infer Tails] + ? QueriesResults< + [...Tails], + [...TResults, GetCreateQueryResult], + [...TDepth, 1] + > + : T extends QueryObserverOptionsForCreateQueries< + infer TQueryFnData, + infer TError, + infer TData, + any + >[] + ? QueryObserverResult< + unknown extends TData ? TQueryFnData : TData, + unknown extends TError ? DefaultError : TError + >[] + : QueryObserverResult[] ``` QueriesResults reducer recursively maps type param to results @@ -21,4 +44,4 @@ QueriesResults reducer recursively maps type param to results ## Defined in -[packages/svelte-query/src/createQueries.ts:171](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/createQueries.ts#L171) +[packages/svelte-query/src/createQueries.ts:171](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQueries.ts#L171) diff --git a/docs/framework/svelte/reference/type-aliases/storeorval.md b/docs/framework/svelte/reference/type-aliases/storeorval.md index 7f7c5d5125..fc38d49b6d 100644 --- a/docs/framework/svelte/reference/type-aliases/storeorval.md +++ b/docs/framework/svelte/reference/type-aliases/storeorval.md @@ -6,7 +6,7 @@ title: StoreOrVal # Type Alias: StoreOrVal\ ```ts -type StoreOrVal: T | Readable; +type StoreOrVal = T | Readable ``` Allows a type to be either the base object or a store of that object @@ -17,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/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/types.ts#L20) +[packages/svelte-query/src/types.ts:21](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L21) diff --git a/docs/framework/svelte/reference/type-aliases/undefinedinitialdataoptions.md b/docs/framework/svelte/reference/type-aliases/undefinedinitialdataoptions.md index de13b3d802..865ccff6f7 100644 --- a/docs/framework/svelte/reference/type-aliases/undefinedinitialdataoptions.md +++ b/docs/framework/svelte/reference/type-aliases/undefinedinitialdataoptions.md @@ -6,7 +6,8 @@ title: UndefinedInitialDataOptions # Type Alias: UndefinedInitialDataOptions\ ```ts -type UndefinedInitialDataOptions: CreateQueryOptions & object; +type UndefinedInitialDataOptions = + CreateQueryOptions & object ``` ## Type declaration @@ -14,7 +15,7 @@ type UndefinedInitialDataOptions: Create ### initialData? ```ts -optional initialData: undefined; +optional initialData: InitialDataFunction>; ``` ## Type Parameters @@ -29,4 +30,4 @@ optional initialData: undefined; ## Defined in -[packages/svelte-query/src/queryOptions.ts:4](https://github.com/TanStack/query/blob/dac5da5416b82b0be38a8fb34dde1fc6670f0a59/packages/svelte-query/src/queryOptions.ts#L4) +[packages/svelte-query/src/queryOptions.ts:9](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L9) From 683eaf57407a0cf7425d69f9c5cce01266dfdf15 Mon Sep 17 00:00:00 2001 From: Lachlan Collins <1667261+lachlancollins@users.noreply.github.com> Date: Thu, 16 Jan 2025 09:42:42 +1100 Subject: [PATCH 2/3] update tanstack config --- .../functions/infinitequeryoptions.md | 18 +-- .../functions/injectinfinitequery.md | 26 ++- .../reference/functions/injectisfetching.md | 10 +- .../reference/functions/injectismutating.md | 10 +- .../reference/functions/injectmutation.md | 8 +- .../functions/injectmutationstate.md | 10 +- .../reference/functions/injectqueries.md | 12 +- .../reference/functions/injectquery.md | 20 +-- .../reference/functions/injectqueryclient.md | 8 +- .../reference/functions/mutationoptions.md | 8 +- .../functions/provideangularquery.md | 8 +- .../reference/functions/providequeryclient.md | 8 +- .../functions/providetanstackquery.md | 8 +- .../reference/functions/queryoptions.md | 14 +- .../reference/functions/withdevtools.md | 8 +- docs/framework/angular/reference/index.md | 6 +- .../interfaces/basemutationnarrowing.md | 20 +-- .../interfaces/basequerynarrowing.md | 22 ++- .../interfaces/createbasequeryoptions.md | 4 + .../interfaces/createinfinitequeryoptions.md | 4 + .../interfaces/createmutationoptions.md | 4 + .../interfaces/createqueryoptions.md | 4 + .../reference/interfaces/devtoolsoptions.md | 52 +++--- .../interfaces/injectmutationstateoptions.md | 8 +- .../reference/interfaces/queryfeature.md | 12 +- .../type-aliases/createbasemutationresult.md | 8 +- .../type-aliases/createbasequeryresult.md | 8 +- .../type-aliases/createinfinitequeryresult.md | 8 +- .../type-aliases/createmutateasyncfunction.md | 8 +- .../type-aliases/createmutatefunction.md | 8 +- .../type-aliases/createmutationresult.md | 8 +- .../type-aliases/createqueryresult.md | 8 +- .../definedcreateinfinitequeryresult.md | 8 +- .../type-aliases/definedcreatequeryresult.md | 8 +- .../definedinitialdatainfiniteoptions.md | 8 +- .../type-aliases/definedinitialdataoptions.md | 8 +- .../type-aliases/developertoolsfeature.md | 8 +- .../type-aliases/nonundefinedguard.md | 8 +- .../reference/type-aliases/queriesoptions.md | 12 +- .../reference/type-aliases/queriesresults.md | 12 +- .../type-aliases/queryfeaturekind.md | 6 +- .../reference/type-aliases/queryfeatures.md | 8 +- .../undefinedinitialdatainfiniteoptions.md | 8 +- .../undefinedinitialdataoptions.md | 8 +- .../reference/variables/queryfeatures.md | 6 +- .../reference/classes/hydrationboundary.md | 98 ++++++------ .../functions/createinfinitequery.md | 10 +- .../reference/functions/createmutation.md | 8 +- .../reference/functions/createqueries.md | 12 +- .../svelte/reference/functions/createquery.md | 20 +-- .../functions/getisrestoringcontext.md | 8 +- .../functions/getqueryclientcontext.md | 8 +- .../functions/infinitequeryoptions.md | 10 +- .../reference/functions/queryoptions.md | 14 +- .../functions/setisrestoringcontext.md | 8 +- .../functions/setqueryclientcontext.md | 8 +- .../svelte/reference/functions/usehydrate.md | 8 +- .../reference/functions/useisfetching.md | 10 +- .../reference/functions/useismutating.md | 10 +- .../reference/functions/useisrestoring.md | 8 +- .../reference/functions/usemutationstate.md | 10 +- .../reference/functions/usequeryclient.md | 8 +- docs/framework/svelte/reference/index.md | 2 + .../type-aliases/createbasemutationresult.md | 8 +- .../type-aliases/createbasequeryoptions.md | 8 +- .../type-aliases/createbasequeryresult.md | 8 +- .../createinfinitequeryoptions.md | 8 +- .../type-aliases/createinfinitequeryresult.md | 8 +- .../type-aliases/createmutateasyncfunction.md | 8 +- .../type-aliases/createmutatefunction.md | 8 +- .../type-aliases/createmutationoptions.md | 8 +- .../type-aliases/createmutationresult.md | 8 +- .../type-aliases/createqueryoptions.md | 8 +- .../type-aliases/createqueryresult.md | 8 +- .../definedcreatebasequeryresult.md | 8 +- .../type-aliases/definedcreatequeryresult.md | 8 +- .../type-aliases/definedinitialdataoptions.md | 8 +- .../type-aliases/mutationstateoptions.md | 8 +- .../reference/type-aliases/queriesoptions.md | 12 +- .../reference/type-aliases/queriesresults.md | 12 +- .../reference/type-aliases/storeorval.md | 8 +- .../undefinedinitialdataoptions.md | 8 +- package.json | 2 +- pnpm-lock.yaml | 149 ++++++------------ 84 files changed, 487 insertions(+), 560 deletions(-) diff --git a/docs/framework/angular/reference/functions/infinitequeryoptions.md b/docs/framework/angular/reference/functions/infinitequeryoptions.md index b521cd336b..287d0da03e 100644 --- a/docs/framework/angular/reference/functions/infinitequeryoptions.md +++ b/docs/framework/angular/reference/functions/infinitequeryoptions.md @@ -3,6 +3,8 @@ id: infiniteQueryOptions title: infiniteQueryOptions --- + + # Function: infiniteQueryOptions() Allows to share and re-use infinite query options in a type-safe way. @@ -34,6 +36,8 @@ function infiniteQueryOptions< object ``` +Defined in: [infinite-query-options.ts:59](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L59) + Allows to share and re-use infinite query options in a type-safe way. The `queryKey` will be tagged with the type from `queryFn`. @@ -44,7 +48,7 @@ The `queryKey` will be tagged with the type from `queryFn`. • **TError** = `Error` -• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> +• **TData** = `InfiniteData`\<`TQueryFnData`\> • **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] @@ -70,10 +74,6 @@ The tagged infinite query options. The infinite query options to tag with the type from `queryFn`. -### Defined in - -[infinite-query-options.ts:59](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L59) - ## Call Signature ```ts @@ -95,6 +95,8 @@ function infiniteQueryOptions< object ``` +Defined in: [infinite-query-options.ts:91](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L91) + Allows to share and re-use infinite query options in a type-safe way. The `queryKey` will be tagged with the type from `queryFn`. @@ -105,7 +107,7 @@ The `queryKey` will be tagged with the type from `queryFn`. • **TError** = `Error` -• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> +• **TData** = `InfiniteData`\<`TQueryFnData`\> • **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] @@ -130,7 +132,3 @@ The tagged infinite query options. ### Param The infinite query options to tag with the type from `queryFn`. - -### Defined in - -[infinite-query-options.ts:91](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L91) diff --git a/docs/framework/angular/reference/functions/injectinfinitequery.md b/docs/framework/angular/reference/functions/injectinfinitequery.md index fc40a60f6b..d968026db3 100644 --- a/docs/framework/angular/reference/functions/injectinfinitequery.md +++ b/docs/framework/angular/reference/functions/injectinfinitequery.md @@ -3,6 +3,8 @@ id: injectInfiniteQuery title: injectInfiniteQuery --- + + # Function: injectInfiniteQuery() Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key. @@ -28,6 +30,8 @@ function injectInfiniteQuery< >(optionsFn, injector?): DefinedCreateInfiniteQueryResult ``` +Defined in: [inject-infinite-query.ts:29](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L29) + Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key. Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll" @@ -37,7 +41,7 @@ Infinite queries can additively "load more" data onto an existing set of data or • **TError** = `Error` -• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> +• **TData** = `InfiniteData`\<`TQueryFnData`\> • **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] @@ -73,10 +77,6 @@ A function that returns infinite query options. The Angular injector to use. -### Defined in - -[inject-infinite-query.ts:29](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L29) - ## Call Signature ```ts @@ -89,6 +89,8 @@ function injectInfiniteQuery< >(optionsFn, injector?): CreateInfiniteQueryResult ``` +Defined in: [inject-infinite-query.ts:54](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L54) + Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key. Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll" @@ -98,7 +100,7 @@ Infinite queries can additively "load more" data onto an existing set of data or • **TError** = `Error` -• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> +• **TData** = `InfiniteData`\<`TQueryFnData`\> • **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] @@ -134,10 +136,6 @@ A function that returns infinite query options. The Angular injector to use. -### Defined in - -[inject-infinite-query.ts:54](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L54) - ## Call Signature ```ts @@ -150,6 +148,8 @@ function injectInfiniteQuery< >(optionsFn, injector?): CreateInfiniteQueryResult ``` +Defined in: [inject-infinite-query.ts:79](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L79) + Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key. Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll" @@ -159,7 +159,7 @@ Infinite queries can additively "load more" data onto an existing set of data or • **TError** = `Error` -• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> +• **TData** = `InfiniteData`\<`TQueryFnData`\> • **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] @@ -194,7 +194,3 @@ A function that returns infinite query options. ### Param The Angular injector to use. - -### Defined in - -[inject-infinite-query.ts:79](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L79) diff --git a/docs/framework/angular/reference/functions/injectisfetching.md b/docs/framework/angular/reference/functions/injectisfetching.md index 541d3a8bff..3d4bad94af 100644 --- a/docs/framework/angular/reference/functions/injectisfetching.md +++ b/docs/framework/angular/reference/functions/injectisfetching.md @@ -3,12 +3,16 @@ id: injectIsFetching title: injectIsFetching --- + + # Function: injectIsFetching() ```ts function injectIsFetching(filters?, injector?): Signal ``` +Defined in: [inject-is-fetching.ts:17](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-fetching.ts#L17) + Injects a signal that tracks the number of queries that your application is loading or fetching in the background. @@ -18,7 +22,7 @@ Can be used for app-wide loading indicators ### filters? -`QueryFilters`\<`unknown`, `Error`, `unknown`, readonly `unknown`[]\> +`QueryFilters` The filters to apply to the query. @@ -33,7 +37,3 @@ The Angular injector to use. `Signal`\<`number`\> signal with number of loading or fetching queries. - -## Defined in - -[inject-is-fetching.ts:17](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-fetching.ts#L17) diff --git a/docs/framework/angular/reference/functions/injectismutating.md b/docs/framework/angular/reference/functions/injectismutating.md index bd80d15950..e2393ec4cb 100644 --- a/docs/framework/angular/reference/functions/injectismutating.md +++ b/docs/framework/angular/reference/functions/injectismutating.md @@ -3,12 +3,16 @@ id: injectIsMutating title: injectIsMutating --- + + # Function: injectIsMutating() ```ts function injectIsMutating(filters?, injector?): Signal ``` +Defined in: [inject-is-mutating.ts:16](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-mutating.ts#L16) + Injects a signal that tracks the number of mutations that your application is fetching. Can be used for app-wide loading indicators @@ -17,7 +21,7 @@ Can be used for app-wide loading indicators ### filters? -`MutationFilters`\<`unknown`, `Error`, `unknown`, `unknown`\> +`MutationFilters` The filters to apply to the query. @@ -32,7 +36,3 @@ The Angular injector to use. `Signal`\<`number`\> signal with number of fetching mutations. - -## Defined in - -[inject-is-mutating.ts:16](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-mutating.ts#L16) diff --git a/docs/framework/angular/reference/functions/injectmutation.md b/docs/framework/angular/reference/functions/injectmutation.md index 7a2a85f9c6..e2f6557229 100644 --- a/docs/framework/angular/reference/functions/injectmutation.md +++ b/docs/framework/angular/reference/functions/injectmutation.md @@ -3,6 +3,8 @@ id: injectMutation title: injectMutation --- + + # Function: injectMutation() ```ts @@ -12,6 +14,8 @@ function injectMutation( ): CreateMutationResult ``` +Defined in: [inject-mutation.ts:33](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L33) + Injects a mutation: an imperative function that can be invoked which typically performs server side effects. Unlike queries, mutations are not run automatically. @@ -45,7 +49,3 @@ The Angular injector to use. [`CreateMutationResult`](../type-aliases/createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TContext`\> The mutation. - -## Defined in - -[inject-mutation.ts:33](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L33) diff --git a/docs/framework/angular/reference/functions/injectmutationstate.md b/docs/framework/angular/reference/functions/injectmutationstate.md index b56caa7157..b33fce6441 100644 --- a/docs/framework/angular/reference/functions/injectmutationstate.md +++ b/docs/framework/angular/reference/functions/injectmutationstate.md @@ -3,6 +3,8 @@ id: injectMutationState title: injectMutationState --- + + # Function: injectMutationState() ```ts @@ -12,11 +14,13 @@ function injectMutationState( ): Signal ``` +Defined in: [inject-mutation-state.ts:47](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation-state.ts#L47) + Injects a signal that tracks the state of all mutations. ## Type Parameters -• **TResult** = `MutationState`\<`unknown`, `Error`, `unknown`, `unknown`\> +• **TResult** = `MutationState` ## Parameters @@ -37,7 +41,3 @@ The Angular injector to use. `Signal`\<`TResult`[]\> The signal that tracks the state of all mutations. - -## Defined in - -[inject-mutation-state.ts:47](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation-state.ts#L47) diff --git a/docs/framework/angular/reference/functions/injectqueries.md b/docs/framework/angular/reference/functions/injectqueries.md index 4840d054ba..773f0502cf 100644 --- a/docs/framework/angular/reference/functions/injectqueries.md +++ b/docs/framework/angular/reference/functions/injectqueries.md @@ -3,6 +3,8 @@ id: injectQueries title: injectQueries --- + + # Function: injectQueries() ```ts @@ -12,11 +14,13 @@ function injectQueries( ): Signal ``` +Defined in: [inject-queries.ts:198](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L198) + ## Type Parameters • **T** _extends_ `any`[] -• **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`[] +• **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`[] ## Parameters @@ -28,7 +32,7 @@ function injectQueries( #### queries -`Signal`\<[`...(T extends [] ? [] : T extends [Head] ? [GetOptions] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions, GetOptions] : [...Tail[]] extends [Head, ...Tail[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[])[]`]\> +`Signal`\<\[`...(T extends [] ? [] : T extends [Head] ? [GetOptions] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions, GetOptions] : [...Tail[]] extends [Head, ...Tail[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[])[]`\]\> ### injector? @@ -37,7 +41,3 @@ function injectQueries( ## Returns `Signal`\<`TCombinedResult`\> - -## Defined in - -[inject-queries.ts:198](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L198) diff --git a/docs/framework/angular/reference/functions/injectquery.md b/docs/framework/angular/reference/functions/injectquery.md index a4de522ad3..4a473ce05c 100644 --- a/docs/framework/angular/reference/functions/injectquery.md +++ b/docs/framework/angular/reference/functions/injectquery.md @@ -3,6 +3,8 @@ id: injectQuery title: injectQuery --- + + # Function: injectQuery() Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key. @@ -59,6 +61,8 @@ function injectQuery( ): DefinedCreateQueryResult ``` +Defined in: [inject-query.ts:53](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L53) + Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key. **Basic example** @@ -140,10 +144,6 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries https://tanstack.com/query/latest/docs/framework/angular/guides/queries -### Defined in - -[inject-query.ts:53](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L53) - ## Call Signature ```ts @@ -153,6 +153,8 @@ function injectQuery( ): CreateQueryResult ``` +Defined in: [inject-query.ts:105](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L105) + Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key. **Basic example** @@ -234,10 +236,6 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries https://tanstack.com/query/latest/docs/framework/angular/guides/queries -### Defined in - -[inject-query.ts:105](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L105) - ## Call Signature ```ts @@ -247,6 +245,8 @@ function injectQuery( ): CreateQueryResult ``` +Defined in: [inject-query.ts:157](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L157) + Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key. **Basic example** @@ -327,7 +327,3 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries ### See https://tanstack.com/query/latest/docs/framework/angular/guides/queries - -### Defined in - -[inject-query.ts:157](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L157) diff --git a/docs/framework/angular/reference/functions/injectqueryclient.md b/docs/framework/angular/reference/functions/injectqueryclient.md index fbe1a39573..f54068abac 100644 --- a/docs/framework/angular/reference/functions/injectqueryclient.md +++ b/docs/framework/angular/reference/functions/injectqueryclient.md @@ -3,12 +3,16 @@ id: injectQueryClient title: injectQueryClient --- + + # Function: ~~injectQueryClient()~~ ```ts function injectQueryClient(injectOptions): QueryClient ``` +Defined in: [inject-query-client.ts:19](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query-client.ts#L19) + Injects a `QueryClient` instance and allows passing a custom injector. ## Parameters @@ -35,7 +39,3 @@ If you need to get a `QueryClient` from a custom injector, use `injector.get(Que ```ts const queryClient = injectQueryClient() ``` - -## Defined in - -[inject-query-client.ts:19](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query-client.ts#L19) diff --git a/docs/framework/angular/reference/functions/mutationoptions.md b/docs/framework/angular/reference/functions/mutationoptions.md index 3acb8200ce..12dd7782a1 100644 --- a/docs/framework/angular/reference/functions/mutationoptions.md +++ b/docs/framework/angular/reference/functions/mutationoptions.md @@ -3,6 +3,8 @@ id: mutationOptions title: mutationOptions --- + + # Function: mutationOptions() ```ts @@ -11,6 +13,8 @@ function mutationOptions( ): CreateMutationOptions ``` +Defined in: [mutation-options.ts:38](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/mutation-options.ts#L38) + Allows to share and re-use mutation options in a type-safe way. **Example** @@ -61,7 +65,3 @@ The mutation options. [`CreateMutationOptions`](../interfaces/createmutationoptions.md)\<`TData`, `TError`, `TVariables`, `TContext`\> Mutation options. - -## Defined in - -[mutation-options.ts:38](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/mutation-options.ts#L38) diff --git a/docs/framework/angular/reference/functions/provideangularquery.md b/docs/framework/angular/reference/functions/provideangularquery.md index 5b43fd3665..f79b96645e 100644 --- a/docs/framework/angular/reference/functions/provideangularquery.md +++ b/docs/framework/angular/reference/functions/provideangularquery.md @@ -3,12 +3,16 @@ id: provideAngularQuery title: provideAngularQuery --- + + # Function: ~~provideAngularQuery()~~ ```ts function provideAngularQuery(queryClient): EnvironmentProviders ``` +Defined in: [providers.ts:125](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L125) + Sets up providers necessary to enable TanStack Query functionality for Angular applications. Allows to configure a `QueryClient`. @@ -34,7 +38,3 @@ https://tanstack.com/query/v5/docs/framework/angular/quick-start ## Deprecated Use `provideTanStackQuery` instead. - -## Defined in - -[providers.ts:125](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L125) diff --git a/docs/framework/angular/reference/functions/providequeryclient.md b/docs/framework/angular/reference/functions/providequeryclient.md index e381268816..11e160fa15 100644 --- a/docs/framework/angular/reference/functions/providequeryclient.md +++ b/docs/framework/angular/reference/functions/providequeryclient.md @@ -3,12 +3,16 @@ id: provideQueryClient title: provideQueryClient --- + + # Function: provideQueryClient() ```ts function provideQueryClient(queryClient): object ``` +Defined in: [providers.ts:32](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L32) + Usually [provideTanStackQuery](providetanstackquery.md) is used once to set up TanStack Query and the [https://tanstack.com/query/latest/docs/reference/QueryClient\|QueryClient](https://tanstack.com/query/latest/docs/reference/QueryClient|QueryClient) for the entire application. You can use `provideQueryClient` to provide a @@ -37,7 +41,3 @@ provide: typeof QueryClient = QueryClient; ```ts useValue: QueryClient = queryClient ``` - -## Defined in - -[providers.ts:32](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L32) diff --git a/docs/framework/angular/reference/functions/providetanstackquery.md b/docs/framework/angular/reference/functions/providetanstackquery.md index c69620029a..afa59bf1ca 100644 --- a/docs/framework/angular/reference/functions/providetanstackquery.md +++ b/docs/framework/angular/reference/functions/providetanstackquery.md @@ -3,12 +3,16 @@ id: provideTanStackQuery title: provideTanStackQuery --- + + # Function: provideTanStackQuery() ```ts function provideTanStackQuery(queryClient, ...features): EnvironmentProviders ``` +Defined in: [providers.ts:95](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L95) + Sets up providers necessary to enable TanStack Query functionality for Angular applications. Allows to configure a `QueryClient` and optional features such as developer tools. @@ -86,7 +90,3 @@ A set of providers to set up TanStack Query. - https://tanstack.com/query/v5/docs/framework/angular/quick-start - withDevtools - -## Defined in - -[providers.ts:95](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L95) diff --git a/docs/framework/angular/reference/functions/queryoptions.md b/docs/framework/angular/reference/functions/queryoptions.md index 99c3ad8fac..746a2c6377 100644 --- a/docs/framework/angular/reference/functions/queryoptions.md +++ b/docs/framework/angular/reference/functions/queryoptions.md @@ -3,6 +3,8 @@ id: queryOptions title: queryOptions --- + + # Function: queryOptions() Allows to share and re-use query options in a type-safe way. @@ -35,6 +37,8 @@ function queryOptions( ): DefinedInitialDataOptions & object ``` +Defined in: [query-options.ts:57](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L57) + Allows to share and re-use query options in a type-safe way. The `queryKey` will be tagged with the type from `queryFn`. @@ -83,10 +87,6 @@ The tagged query options. The query options to tag with the type from `queryFn`. -### Defined in - -[query-options.ts:57](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L57) - ## Call Signature ```ts @@ -95,6 +95,8 @@ function queryOptions( ): UndefinedInitialDataOptions & object ``` +Defined in: [query-options.ts:90](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L90) + Allows to share and re-use query options in a type-safe way. The `queryKey` will be tagged with the type from `queryFn`. @@ -142,7 +144,3 @@ The tagged query options. ### Param The query options to tag with the type from `queryFn`. - -### Defined in - -[query-options.ts:90](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L90) diff --git a/docs/framework/angular/reference/functions/withdevtools.md b/docs/framework/angular/reference/functions/withdevtools.md index 177bea40ec..6517fc0866 100644 --- a/docs/framework/angular/reference/functions/withdevtools.md +++ b/docs/framework/angular/reference/functions/withdevtools.md @@ -3,12 +3,16 @@ id: withDevtools title: withDevtools --- + + # Function: withDevtools() ```ts function withDevtools(optionsFn?): DeveloperToolsFeature ``` +Defined in: [providers.ts:244](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L244) + Enables developer tools. **Example** @@ -43,7 +47,3 @@ A set of providers for use with `provideTanStackQuery`. - [provideTanStackQuery](providetanstackquery.md) - [DevtoolsOptions](../interfaces/devtoolsoptions.md) - -## Defined in - -[providers.ts:244](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L244) diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md index f26424adb9..9a3fa9fa9e 100644 --- a/docs/framework/angular/reference/index.md +++ b/docs/framework/angular/reference/index.md @@ -3,6 +3,8 @@ id: '@tanstack/angular-query-experimental' title: '@tanstack/angular-query-experimental' --- + + # @tanstack/angular-query-experimental ## Interfaces @@ -53,9 +55,9 @@ title: '@tanstack/angular-query-experimental' - [injectMutationState](functions/injectmutationstate.md) - [injectQueries](functions/injectqueries.md) - [injectQuery](functions/injectquery.md) -- [injectQueryClient](functions/injectqueryclient.md) +- [~~injectQueryClient~~](functions/injectqueryclient.md) - [mutationOptions](functions/mutationoptions.md) -- [provideAngularQuery](functions/provideangularquery.md) +- [~~provideAngularQuery~~](functions/provideangularquery.md) - [provideQueryClient](functions/providequeryclient.md) - [provideTanStackQuery](functions/providetanstackquery.md) - [queryOptions](functions/queryoptions.md) diff --git a/docs/framework/angular/reference/interfaces/basemutationnarrowing.md b/docs/framework/angular/reference/interfaces/basemutationnarrowing.md index 458adf172e..e10f54fdf2 100644 --- a/docs/framework/angular/reference/interfaces/basemutationnarrowing.md +++ b/docs/framework/angular/reference/interfaces/basemutationnarrowing.md @@ -3,8 +3,12 @@ id: BaseMutationNarrowing title: BaseMutationNarrowing --- + + # Interface: BaseMutationNarrowing\ +Defined in: [types.ts:218](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L218) + ## Type Parameters • **TData** = `unknown` @@ -43,9 +47,7 @@ isError: SignalFunction< > ``` -#### Defined in - -[types.ts:241](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L241) +Defined in: [types.ts:241](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L241) --- @@ -75,9 +77,7 @@ isIdle: SignalFunction< > ``` -#### Defined in - -[types.ts:275](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L275) +Defined in: [types.ts:275](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L275) --- @@ -107,9 +107,7 @@ isPending: SignalFunction< > ``` -#### Defined in - -[types.ts:258](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L258) +Defined in: [types.ts:258](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L258) --- @@ -139,6 +137,4 @@ isSuccess: SignalFunction< > ``` -#### Defined in - -[types.ts:224](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L224) +Defined in: [types.ts:224](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L224) diff --git a/docs/framework/angular/reference/interfaces/basequerynarrowing.md b/docs/framework/angular/reference/interfaces/basequerynarrowing.md index 649539af2a..9850d49117 100644 --- a/docs/framework/angular/reference/interfaces/basequerynarrowing.md +++ b/docs/framework/angular/reference/interfaces/basequerynarrowing.md @@ -3,8 +3,12 @@ id: BaseQueryNarrowing title: BaseQueryNarrowing --- + + # Interface: BaseQueryNarrowing\ +Defined in: [types.ts:68](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L68) + ## Type Parameters • **TData** = `unknown` @@ -19,6 +23,8 @@ title: BaseQueryNarrowing isError: (this) => this is CreateBaseQueryResult>; ``` +Defined in: [types.ts:76](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L76) + #### Parameters ##### this @@ -29,10 +35,6 @@ isError: (this) => this is CreateBaseQueryResult>` -#### Defined in - -[types.ts:76](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L76) - --- ### isPending() @@ -41,6 +43,8 @@ isError: (this) => this is CreateBaseQueryResult this is CreateBaseQueryResult>; ``` +Defined in: [types.ts:83](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L83) + #### Parameters ##### this @@ -51,10 +55,6 @@ isPending: (this) => this is CreateBaseQueryResult>` -#### Defined in - -[types.ts:83](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L83) - --- ### isSuccess() @@ -63,6 +63,8 @@ isPending: (this) => this is CreateBaseQueryResult this is CreateBaseQueryResult>; ``` +Defined in: [types.ts:69](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L69) + #### Parameters ##### this @@ -72,7 +74,3 @@ isSuccess: (this) => this is CreateBaseQueryResult>` - -#### Defined in - -[types.ts:69](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L69) diff --git a/docs/framework/angular/reference/interfaces/createbasequeryoptions.md b/docs/framework/angular/reference/interfaces/createbasequeryoptions.md index c371959980..f3ae0e2baf 100644 --- a/docs/framework/angular/reference/interfaces/createbasequeryoptions.md +++ b/docs/framework/angular/reference/interfaces/createbasequeryoptions.md @@ -3,8 +3,12 @@ id: CreateBaseQueryOptions title: CreateBaseQueryOptions --- + + # Interface: CreateBaseQueryOptions\ +Defined in: [types.ts:23](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L23) + ## Extends - `QueryObserverOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`\> diff --git a/docs/framework/angular/reference/interfaces/createinfinitequeryoptions.md b/docs/framework/angular/reference/interfaces/createinfinitequeryoptions.md index dade8e1e30..ae3ee11cbd 100644 --- a/docs/framework/angular/reference/interfaces/createinfinitequeryoptions.md +++ b/docs/framework/angular/reference/interfaces/createinfinitequeryoptions.md @@ -3,8 +3,12 @@ id: CreateInfiniteQueryOptions title: CreateInfiniteQueryOptions --- + + # Interface: CreateInfiniteQueryOptions\ +Defined in: [types.ts:95](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L95) + ## Extends - `OmitKeyof`\<`InfiniteQueryObserverOptions`\<`TQueryFnData`, `TError`, `TData`, `TQueryData`, `TQueryKey`, `TPageParam`\>, `"suspense"`\> diff --git a/docs/framework/angular/reference/interfaces/createmutationoptions.md b/docs/framework/angular/reference/interfaces/createmutationoptions.md index ffca256828..6ef7c6830b 100644 --- a/docs/framework/angular/reference/interfaces/createmutationoptions.md +++ b/docs/framework/angular/reference/interfaces/createmutationoptions.md @@ -3,8 +3,12 @@ id: CreateMutationOptions title: CreateMutationOptions --- + + # Interface: CreateMutationOptions\ +Defined in: [mutation-options.ts:52](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/mutation-options.ts#L52) + ## Extends - `OmitKeyof`\<`MutationObserverOptions`\<`TData`, `TError`, `TVariables`, `TContext`\>, `"_defaulted"`\> diff --git a/docs/framework/angular/reference/interfaces/createqueryoptions.md b/docs/framework/angular/reference/interfaces/createqueryoptions.md index 739f7179f7..73b9fc8e57 100644 --- a/docs/framework/angular/reference/interfaces/createqueryoptions.md +++ b/docs/framework/angular/reference/interfaces/createqueryoptions.md @@ -3,8 +3,12 @@ id: CreateQueryOptions title: CreateQueryOptions --- + + # Interface: CreateQueryOptions\ +Defined in: [types.ts:40](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L40) + ## Extends - `OmitKeyof`\<[`CreateBaseQueryOptions`](createbasequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`\>, `"suspense"`\> diff --git a/docs/framework/angular/reference/interfaces/devtoolsoptions.md b/docs/framework/angular/reference/interfaces/devtoolsoptions.md index 5669aaca53..33e95becc0 100644 --- a/docs/framework/angular/reference/interfaces/devtoolsoptions.md +++ b/docs/framework/angular/reference/interfaces/devtoolsoptions.md @@ -3,8 +3,12 @@ id: DevtoolsOptions title: DevtoolsOptions --- + + # Interface: DevtoolsOptions +Defined in: [providers.ts:164](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L164) + Options for configuring the TanStack Query devtools. ## Properties @@ -15,14 +19,12 @@ Options for configuring the TanStack Query devtools. optional buttonPosition: DevtoolsButtonPosition; ``` +Defined in: [providers.ts:174](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L174) + The position of the TanStack logo to open and close the devtools panel. `top-left` | `top-right` | `bottom-left` | `bottom-right` | `relative` Defaults to `bottom-right`. -#### Defined in - -[providers.ts:174](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L174) - --- ### client? @@ -31,11 +33,9 @@ Defaults to `bottom-right`. optional client: QueryClient; ``` -Custom instance of QueryClient - -#### Defined in +Defined in: [providers.ts:184](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L184) -[providers.ts:184](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L184) +Custom instance of QueryClient --- @@ -45,11 +45,9 @@ Custom instance of QueryClient optional errorTypes: DevtoolsErrorType[]; ``` -Use this so you can define custom errors that can be shown in the devtools. - -#### Defined in +Defined in: [providers.ts:188](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L188) -[providers.ts:188](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L188) +Use this so you can define custom errors that can be shown in the devtools. --- @@ -59,11 +57,9 @@ Use this so you can define custom errors that can be shown in the devtools. optional initialIsOpen: boolean; ``` -Set this true if you want the devtools to default to being open - -#### Defined in +Defined in: [providers.ts:168](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L168) -[providers.ts:168](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L168) +Set this true if you want the devtools to default to being open --- @@ -73,6 +69,8 @@ Set this true if you want the devtools to default to being open optional loadDevtools: boolean | "auto"; ``` +Defined in: [providers.ts:218](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L218) + Whether the developer tools should load. - `auto`- (Default) Lazily loads devtools when in development mode. Skips loading in production mode. @@ -94,10 +92,6 @@ withDevtools(() => ({ })) ``` -#### Defined in - -[providers.ts:218](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L218) - --- ### position? @@ -106,14 +100,12 @@ withDevtools(() => ({ optional position: DevtoolsPosition; ``` +Defined in: [providers.ts:180](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L180) + The position of the TanStack Query devtools panel. `top` | `bottom` | `left` | `right` Defaults to `bottom`. -#### Defined in - -[providers.ts:180](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L180) - --- ### shadowDOMTarget? @@ -122,11 +114,9 @@ Defaults to `bottom`. optional shadowDOMTarget: ShadowRoot; ``` -Use this so you can attach the devtool's styles to a specific element in the DOM. - -#### Defined in +Defined in: [providers.ts:196](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L196) -[providers.ts:196](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L196) +Use this so you can attach the devtool's styles to a specific element in the DOM. --- @@ -136,8 +126,6 @@ Use this so you can attach the devtool's styles to a specific element in the DOM optional styleNonce: string; ``` -Use this to pass a nonce to the style tag that is added to the document head. This is useful if you are using a Content Security Policy (CSP) nonce to allow inline styles. - -#### Defined in +Defined in: [providers.ts:192](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L192) -[providers.ts:192](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L192) +Use this to pass a nonce to the style tag that is added to the document head. This is useful if you are using a Content Security Policy (CSP) nonce to allow inline styles. diff --git a/docs/framework/angular/reference/interfaces/injectmutationstateoptions.md b/docs/framework/angular/reference/interfaces/injectmutationstateoptions.md index 9c6d160a34..028790d486 100644 --- a/docs/framework/angular/reference/interfaces/injectmutationstateoptions.md +++ b/docs/framework/angular/reference/interfaces/injectmutationstateoptions.md @@ -3,8 +3,12 @@ id: InjectMutationStateOptions title: InjectMutationStateOptions --- + + # Interface: InjectMutationStateOptions +Defined in: [inject-mutation-state.ts:36](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation-state.ts#L36) + ## Properties ### injector? @@ -13,6 +17,4 @@ title: InjectMutationStateOptions optional injector: Injector; ``` -#### Defined in - -[inject-mutation-state.ts:37](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation-state.ts#L37) +Defined in: [inject-mutation-state.ts:37](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation-state.ts#L37) diff --git a/docs/framework/angular/reference/interfaces/queryfeature.md b/docs/framework/angular/reference/interfaces/queryfeature.md index c746b8318e..0c490f405b 100644 --- a/docs/framework/angular/reference/interfaces/queryfeature.md +++ b/docs/framework/angular/reference/interfaces/queryfeature.md @@ -3,8 +3,12 @@ id: QueryFeature title: QueryFeature --- + + # Interface: QueryFeature\ +Defined in: [providers.ts:134](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L134) + Helper type to represent a Query feature. ## Type Parameters @@ -19,9 +23,7 @@ Helper type to represent a Query feature. ɵkind: TFeatureKind ``` -#### Defined in - -[providers.ts:135](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L135) +Defined in: [providers.ts:135](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L135) --- @@ -31,6 +33,4 @@ Helper type to represent a Query feature. ɵproviders: Provider[]; ``` -#### Defined in - -[providers.ts:136](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L136) +Defined in: [providers.ts:136](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L136) diff --git a/docs/framework/angular/reference/type-aliases/createbasemutationresult.md b/docs/framework/angular/reference/type-aliases/createbasemutationresult.md index 54b68f780f..d6d9abfc4e 100644 --- a/docs/framework/angular/reference/type-aliases/createbasemutationresult.md +++ b/docs/framework/angular/reference/type-aliases/createbasemutationresult.md @@ -3,6 +3,8 @@ id: CreateBaseMutationResult title: CreateBaseMutationResult --- + + # Type Alias: CreateBaseMutationResult\ ```ts @@ -15,6 +17,8 @@ type CreateBaseMutationResult = Override< object ``` +Defined in: [types.ts:187](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L187) + ## Type declaration ### mutateAsync @@ -32,7 +36,3 @@ mutateAsync: CreateMutateAsyncFunction • **TVariables** = `unknown` • **TContext** = `unknown` - -## Defined in - -[types.ts:187](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L187) diff --git a/docs/framework/angular/reference/type-aliases/createbasequeryresult.md b/docs/framework/angular/reference/type-aliases/createbasequeryresult.md index f8b5b1d147..c49bddcb54 100644 --- a/docs/framework/angular/reference/type-aliases/createbasequeryresult.md +++ b/docs/framework/angular/reference/type-aliases/createbasequeryresult.md @@ -3,6 +3,8 @@ id: CreateBaseQueryResult title: CreateBaseQueryResult --- + + # Type Alias: CreateBaseQueryResult\ ```ts @@ -13,6 +15,8 @@ type CreateBaseQueryResult = BaseQueryNarrowing< MapToSignals> ``` +Defined in: [types.ts:117](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L117) + ## Type Parameters • **TData** = `unknown` @@ -20,7 +24,3 @@ type CreateBaseQueryResult = BaseQueryNarrowing< • **TError** = `DefaultError` • **TState** = `QueryObserverResult`\<`TData`, `TError`\> - -## Defined in - -[types.ts:117](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L117) diff --git a/docs/framework/angular/reference/type-aliases/createinfinitequeryresult.md b/docs/framework/angular/reference/type-aliases/createinfinitequeryresult.md index 24b39e245b..814f97faed 100644 --- a/docs/framework/angular/reference/type-aliases/createinfinitequeryresult.md +++ b/docs/framework/angular/reference/type-aliases/createinfinitequeryresult.md @@ -3,6 +3,8 @@ id: CreateInfiniteQueryResult title: CreateInfiniteQueryResult --- + + # Type Alias: CreateInfiniteQueryResult\ ```ts @@ -11,12 +13,10 @@ type CreateInfiniteQueryResult = MapToSignals< > ``` +Defined in: [types.ts:145](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L145) + ## Type Parameters • **TData** = `unknown` • **TError** = `DefaultError` - -## Defined in - -[types.ts:145](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L145) diff --git a/docs/framework/angular/reference/type-aliases/createmutateasyncfunction.md b/docs/framework/angular/reference/type-aliases/createmutateasyncfunction.md index 889a44e227..cfc7a582c8 100644 --- a/docs/framework/angular/reference/type-aliases/createmutateasyncfunction.md +++ b/docs/framework/angular/reference/type-aliases/createmutateasyncfunction.md @@ -3,6 +3,8 @@ id: CreateMutateAsyncFunction title: CreateMutateAsyncFunction --- + + # Type Alias: CreateMutateAsyncFunction\ ```ts @@ -10,6 +12,8 @@ type CreateMutateAsyncFunction = MutateFunction ``` +Defined in: [types.ts:177](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L177) + ## Type Parameters • **TData** = `unknown` @@ -19,7 +23,3 @@ type CreateMutateAsyncFunction = • **TVariables** = `void` • **TContext** = `unknown` - -## Defined in - -[types.ts:177](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L177) diff --git a/docs/framework/angular/reference/type-aliases/createmutatefunction.md b/docs/framework/angular/reference/type-aliases/createmutatefunction.md index 4d2fa67e15..276334a97c 100644 --- a/docs/framework/angular/reference/type-aliases/createmutatefunction.md +++ b/docs/framework/angular/reference/type-aliases/createmutatefunction.md @@ -3,6 +3,8 @@ id: CreateMutateFunction title: CreateMutateFunction --- + + # Type Alias: CreateMutateFunction()\ ```ts @@ -11,6 +13,8 @@ type CreateMutateFunction = ( ) => void ``` +Defined in: [types.ts:165](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L165) + ## Type Parameters • **TData** = `unknown` @@ -30,7 +34,3 @@ type CreateMutateFunction = ( ## Returns `void` - -## Defined in - -[types.ts:165](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L165) diff --git a/docs/framework/angular/reference/type-aliases/createmutationresult.md b/docs/framework/angular/reference/type-aliases/createmutationresult.md index 92ff8edd4c..86f66b657a 100644 --- a/docs/framework/angular/reference/type-aliases/createmutationresult.md +++ b/docs/framework/angular/reference/type-aliases/createmutationresult.md @@ -3,6 +3,8 @@ id: CreateMutationResult title: CreateMutationResult --- + + # Type Alias: CreateMutationResult\ ```ts @@ -11,6 +13,8 @@ type CreateMutationResult = MapToSignals> ``` +Defined in: [types.ts:297](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L297) + ## Type Parameters • **TData** = `unknown` @@ -22,7 +26,3 @@ type CreateMutationResult = • **TContext** = `unknown` • **TState** = `CreateStatusBasedMutationResult`\<[`CreateBaseMutationResult`](createbasemutationresult.md)\[`"status"`\], `TData`, `TError`, `TVariables`, `TContext`\> - -## Defined in - -[types.ts:297](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L297) diff --git a/docs/framework/angular/reference/type-aliases/createqueryresult.md b/docs/framework/angular/reference/type-aliases/createqueryresult.md index 78ada66abc..008fe69b7f 100644 --- a/docs/framework/angular/reference/type-aliases/createqueryresult.md +++ b/docs/framework/angular/reference/type-aliases/createqueryresult.md @@ -3,18 +3,18 @@ id: CreateQueryResult title: CreateQueryResult --- + + # Type Alias: CreateQueryResult\ ```ts type CreateQueryResult = CreateBaseQueryResult ``` +Defined in: [types.ts:127](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L127) + ## Type Parameters • **TData** = `unknown` • **TError** = `DefaultError` - -## Defined in - -[types.ts:127](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L127) diff --git a/docs/framework/angular/reference/type-aliases/definedcreateinfinitequeryresult.md b/docs/framework/angular/reference/type-aliases/definedcreateinfinitequeryresult.md index e49e629376..708c1cd697 100644 --- a/docs/framework/angular/reference/type-aliases/definedcreateinfinitequeryresult.md +++ b/docs/framework/angular/reference/type-aliases/definedcreateinfinitequeryresult.md @@ -3,6 +3,8 @@ id: DefinedCreateInfiniteQueryResult title: DefinedCreateInfiniteQueryResult --- + + # Type Alias: DefinedCreateInfiniteQueryResult\ ```ts @@ -13,6 +15,8 @@ type DefinedCreateInfiniteQueryResult< > = MapToSignals ``` +Defined in: [types.ts:153](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L153) + ## Type Parameters • **TData** = `unknown` @@ -20,7 +24,3 @@ type DefinedCreateInfiniteQueryResult< • **TError** = `DefaultError` • **TDefinedInfiniteQueryObserver** = `DefinedInfiniteQueryObserverResult`\<`TData`, `TError`\> - -## Defined in - -[types.ts:153](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L153) diff --git a/docs/framework/angular/reference/type-aliases/definedcreatequeryresult.md b/docs/framework/angular/reference/type-aliases/definedcreatequeryresult.md index abf57a2b9d..39a62e91d3 100644 --- a/docs/framework/angular/reference/type-aliases/definedcreatequeryresult.md +++ b/docs/framework/angular/reference/type-aliases/definedcreatequeryresult.md @@ -3,6 +3,8 @@ id: DefinedCreateQueryResult title: DefinedCreateQueryResult --- + + # Type Alias: DefinedCreateQueryResult\ ```ts @@ -13,6 +15,8 @@ type DefinedCreateQueryResult = BaseQueryNarrowing< MapToSignals> ``` +Defined in: [types.ts:135](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L135) + ## Type Parameters • **TData** = `unknown` @@ -20,7 +24,3 @@ type DefinedCreateQueryResult = BaseQueryNarrowing< • **TError** = `DefaultError` • **TState** = `DefinedQueryObserverResult`\<`TData`, `TError`\> - -## Defined in - -[types.ts:135](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L135) diff --git a/docs/framework/angular/reference/type-aliases/definedinitialdatainfiniteoptions.md b/docs/framework/angular/reference/type-aliases/definedinitialdatainfiniteoptions.md index 07e74cb206..f4df75a366 100644 --- a/docs/framework/angular/reference/type-aliases/definedinitialdatainfiniteoptions.md +++ b/docs/framework/angular/reference/type-aliases/definedinitialdatainfiniteoptions.md @@ -3,6 +3,8 @@ id: DefinedInitialDataInfiniteOptions title: DefinedInitialDataInfiniteOptions --- + + # Type Alias: DefinedInitialDataInfiniteOptions\ ```ts @@ -23,6 +25,8 @@ type DefinedInitialDataInfiniteOptions< object ``` +Defined in: [infinite-query-options.ts:32](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L32) + ## Type declaration ### initialData @@ -44,7 +48,3 @@ initialData: • **TQueryKey** _extends_ `QueryKey` = `QueryKey` • **TPageParam** = `unknown` - -## Defined in - -[infinite-query-options.ts:32](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L32) diff --git a/docs/framework/angular/reference/type-aliases/definedinitialdataoptions.md b/docs/framework/angular/reference/type-aliases/definedinitialdataoptions.md index 9029c257ef..1e7f1da925 100644 --- a/docs/framework/angular/reference/type-aliases/definedinitialdataoptions.md +++ b/docs/framework/angular/reference/type-aliases/definedinitialdataoptions.md @@ -3,6 +3,8 @@ id: DefinedInitialDataOptions title: DefinedInitialDataOptions --- + + # Type Alias: DefinedInitialDataOptions\ ```ts @@ -10,6 +12,8 @@ type DefinedInitialDataOptions = CreateQueryOptions & object ``` +Defined in: [query-options.ts:24](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L24) + ## Type declaration ### initialData @@ -29,7 +33,3 @@ initialData: • **TData** = `TQueryFnData` • **TQueryKey** _extends_ `QueryKey` = `QueryKey` - -## Defined in - -[query-options.ts:24](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L24) diff --git a/docs/framework/angular/reference/type-aliases/developertoolsfeature.md b/docs/framework/angular/reference/type-aliases/developertoolsfeature.md index e76d7972d2..8289a43400 100644 --- a/docs/framework/angular/reference/type-aliases/developertoolsfeature.md +++ b/docs/framework/angular/reference/type-aliases/developertoolsfeature.md @@ -3,19 +3,19 @@ id: DeveloperToolsFeature title: DeveloperToolsFeature --- + + # Type Alias: DeveloperToolsFeature ```ts type DeveloperToolsFeature = QueryFeature<'DeveloperTools'> ``` +Defined in: [providers.ts:158](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L158) + A type alias that represents a feature which enables developer tools. The type is used to describe the return value of the `withDevtools` function. ## See [withDevtools](../functions/withdevtools.md) - -## Defined in - -[providers.ts:158](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L158) diff --git a/docs/framework/angular/reference/type-aliases/nonundefinedguard.md b/docs/framework/angular/reference/type-aliases/nonundefinedguard.md index 192f0ffce0..ba4d8edcc7 100644 --- a/docs/framework/angular/reference/type-aliases/nonundefinedguard.md +++ b/docs/framework/angular/reference/type-aliases/nonundefinedguard.md @@ -3,16 +3,16 @@ id: NonUndefinedGuard title: NonUndefinedGuard --- + + # Type Alias: NonUndefinedGuard\ ```ts type NonUndefinedGuard = T extends undefined ? never : T ``` +Defined in: [types.ts:315](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L315) + ## Type Parameters • **T** - -## Defined in - -[types.ts:315](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L315) diff --git a/docs/framework/angular/reference/type-aliases/queriesoptions.md b/docs/framework/angular/reference/type-aliases/queriesoptions.md index ccfcde6bb2..2617e38758 100644 --- a/docs/framework/angular/reference/type-aliases/queriesoptions.md +++ b/docs/framework/angular/reference/type-aliases/queriesoptions.md @@ -3,6 +3,8 @@ id: QueriesOptions title: QueriesOptions --- + + # Type Alias: QueriesOptions\ ```ts @@ -35,16 +37,14 @@ type QueriesOptions = TDepth['length'] extends MAXIMUM_DEPTH : QueryObserverOptionsForCreateQueries[] ``` +Defined in: [inject-queries.ts:118](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L118) + QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param ## Type Parameters • **T** _extends_ `any`[] -• **TResult** _extends_ `any`[] = [] - -• **TDepth** _extends_ `ReadonlyArray`\<`number`\> = [] - -## Defined in +• **TResult** _extends_ `any`[] = \[\] -[inject-queries.ts:118](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L118) +• **TDepth** _extends_ `ReadonlyArray`\<`number`\> = \[\] diff --git a/docs/framework/angular/reference/type-aliases/queriesresults.md b/docs/framework/angular/reference/type-aliases/queriesresults.md index 9459029976..5c120f2168 100644 --- a/docs/framework/angular/reference/type-aliases/queriesresults.md +++ b/docs/framework/angular/reference/type-aliases/queriesresults.md @@ -3,6 +3,8 @@ id: QueriesResults title: QueriesResults --- + + # Type Alias: QueriesResults\ ```ts @@ -31,16 +33,14 @@ type QueriesResults = TDepth['length'] extends MAXIMUM_DEPTH : QueryObserverResult[] ``` +Defined in: [inject-queries.ts:161](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L161) + QueriesResults reducer recursively maps type param to results ## Type Parameters • **T** _extends_ `any`[] -• **TResult** _extends_ `any`[] = [] - -• **TDepth** _extends_ `ReadonlyArray`\<`number`\> = [] - -## Defined in +• **TResult** _extends_ `any`[] = \[\] -[inject-queries.ts:161](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L161) +• **TDepth** _extends_ `ReadonlyArray`\<`number`\> = \[\] diff --git a/docs/framework/angular/reference/type-aliases/queryfeaturekind.md b/docs/framework/angular/reference/type-aliases/queryfeaturekind.md index 17b762d27d..64ad4478c1 100644 --- a/docs/framework/angular/reference/type-aliases/queryfeaturekind.md +++ b/docs/framework/angular/reference/type-aliases/queryfeaturekind.md @@ -3,12 +3,12 @@ id: QueryFeatureKind title: QueryFeatureKind --- + + # Type Alias: QueryFeatureKind ```ts type QueryFeatureKind = (typeof queryFeatures)[number] ``` -## Defined in - -[providers.ts:353](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L353) +Defined in: [providers.ts:353](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L353) diff --git a/docs/framework/angular/reference/type-aliases/queryfeatures.md b/docs/framework/angular/reference/type-aliases/queryfeatures.md index 652285a226..036d2e49ff 100644 --- a/docs/framework/angular/reference/type-aliases/queryfeatures.md +++ b/docs/framework/angular/reference/type-aliases/queryfeatures.md @@ -3,12 +3,16 @@ id: QueryFeatures title: QueryFeatures --- + + # Type Alias: QueryFeatures ```ts type QueryFeatures = DeveloperToolsFeature ``` +Defined in: [providers.ts:349](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L349) + A type alias that represents all Query features available for use with `provideTanStackQuery`. Features can be enabled by adding special functions to the `provideTanStackQuery` call. See documentation for each symbol to find corresponding function name. See also `provideTanStackQuery` @@ -17,7 +21,3 @@ documentation on how to use those functions. ## See [provideTanStackQuery](../functions/providetanstackquery.md) - -## Defined in - -[providers.ts:349](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L349) diff --git a/docs/framework/angular/reference/type-aliases/undefinedinitialdatainfiniteoptions.md b/docs/framework/angular/reference/type-aliases/undefinedinitialdatainfiniteoptions.md index 70dc60bd4c..861f2561c8 100644 --- a/docs/framework/angular/reference/type-aliases/undefinedinitialdatainfiniteoptions.md +++ b/docs/framework/angular/reference/type-aliases/undefinedinitialdatainfiniteoptions.md @@ -3,6 +3,8 @@ id: UndefinedInitialDataInfiniteOptions title: UndefinedInitialDataInfiniteOptions --- + + # Type Alias: UndefinedInitialDataInfiniteOptions\ ```ts @@ -23,6 +25,8 @@ type UndefinedInitialDataInfiniteOptions< object ``` +Defined in: [infinite-query-options.ts:12](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L12) + ## Type declaration ### initialData? @@ -42,7 +46,3 @@ optional initialData: undefined; • **TQueryKey** _extends_ `QueryKey` = `QueryKey` • **TPageParam** = `unknown` - -## Defined in - -[infinite-query-options.ts:12](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L12) diff --git a/docs/framework/angular/reference/type-aliases/undefinedinitialdataoptions.md b/docs/framework/angular/reference/type-aliases/undefinedinitialdataoptions.md index c53fdf022c..37a2467600 100644 --- a/docs/framework/angular/reference/type-aliases/undefinedinitialdataoptions.md +++ b/docs/framework/angular/reference/type-aliases/undefinedinitialdataoptions.md @@ -3,6 +3,8 @@ id: UndefinedInitialDataOptions title: UndefinedInitialDataOptions --- + + # Type Alias: UndefinedInitialDataOptions\ ```ts @@ -10,6 +12,8 @@ type UndefinedInitialDataOptions = CreateQueryOptions & object ``` +Defined in: [query-options.ts:12](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L12) + ## Type declaration ### initialData? @@ -27,7 +31,3 @@ optional initialData: InitialDataFunction>; • **TData** = `TQueryFnData` • **TQueryKey** _extends_ `QueryKey` = `QueryKey` - -## Defined in - -[query-options.ts:12](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L12) diff --git a/docs/framework/angular/reference/variables/queryfeatures.md b/docs/framework/angular/reference/variables/queryfeatures.md index 82915e99ae..ebb50626fc 100644 --- a/docs/framework/angular/reference/variables/queryfeatures.md +++ b/docs/framework/angular/reference/variables/queryfeatures.md @@ -3,12 +3,12 @@ id: queryFeatures title: queryFeatures --- + + # Variable: queryFeatures ```ts const queryFeatures: readonly ['DeveloperTools'] ``` -## Defined in - -[providers.ts:351](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L351) +Defined in: [providers.ts:351](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L351) diff --git a/docs/framework/svelte/reference/classes/hydrationboundary.md b/docs/framework/svelte/reference/classes/hydrationboundary.md index c4e39e2596..30e0f6382f 100644 --- a/docs/framework/svelte/reference/classes/hydrationboundary.md +++ b/docs/framework/svelte/reference/classes/hydrationboundary.md @@ -3,8 +3,12 @@ id: HydrationBoundary title: HydrationBoundary --- + + # Class: HydrationBoundary\ +Defined in: node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:142 + Base class for Svelte components with some minor dev-enhancements. Used when dev=true. Can be used to create strongly typed Svelte components. @@ -46,7 +50,9 @@ with TypeScript: ## Indexable -\[`prop`: `string`\]: `any` +```ts +[prop: string]: any +``` ## Constructors @@ -56,6 +62,8 @@ with TypeScript: new HydrationBoundary(options): HydrationBoundary ``` +Defined in: node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:144 + #### Parameters ##### options @@ -68,11 +76,9 @@ new HydrationBoundary(options): HydrationBoundary.constructor` - -#### Defined in - -node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:144 +```ts +SvelteComponent_1.constructor +``` ## Properties @@ -82,17 +88,17 @@ node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:144 $$: any ``` +Defined in: node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:102 + ### PRIVATE API Do not use, may change at any time #### Inherited from -`SvelteComponent_1.$$` - -#### Defined in - -node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:102 +```ts +SvelteComponent_1.$$ +``` --- @@ -102,15 +108,13 @@ node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:102 $$events_def: Events ``` +Defined in: node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:158 + For type checking capabilities only. Does not exist at runtime. ### DO NOT USE! -#### Defined in - -node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:158 - --- ### $$prop_def @@ -119,15 +123,13 @@ node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:158 $$prop_def: Props ``` +Defined in: node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:151 + For type checking capabilities only. Does not exist at runtime. ### DO NOT USE! -#### Defined in - -node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:151 - --- ### $$set @@ -136,17 +138,17 @@ node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:151 $$set: any ``` +Defined in: node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:109 + ### PRIVATE API Do not use, may change at any time #### Inherited from -`SvelteComponent_1.$$set` - -#### Defined in - -node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:109 +```ts +SvelteComponent_1.$$set +``` --- @@ -156,15 +158,13 @@ node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:109 $$slot_def: Slots ``` +Defined in: node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:165 + For type checking capabilities only. Does not exist at runtime. ### DO NOT USE! -#### Defined in - -node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:165 - ## Methods ### $capture_state() @@ -173,14 +173,12 @@ node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:165 $capture_state(): void ``` +Defined in: node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:167 + #### Returns `void` -#### Defined in - -node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:167 - --- ### $destroy() @@ -189,17 +187,17 @@ node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:167 $destroy(): void ``` +Defined in: node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:111 + #### Returns `void` #### Inherited from -`SvelteComponent_1.$destroy` - -#### Defined in - -node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:111 +```ts +SvelteComponent_1.$destroy +``` --- @@ -209,14 +207,12 @@ node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:111 $inject_state(): void ``` +Defined in: node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:169 + #### Returns `void` -#### Defined in - -node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:169 - --- ### $on() @@ -225,6 +221,8 @@ node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:169 $on(type, callback): () => void ``` +Defined in: node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:113 + #### Type Parameters • **K** _extends_ `string` @@ -249,11 +247,9 @@ $on(type, callback): () => void #### Inherited from -`SvelteComponent_1.$on` - -#### Defined in - -node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:113 +```ts +SvelteComponent_1.$on +``` --- @@ -263,6 +259,8 @@ node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:113 $set(props): void ``` +Defined in: node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:115 + #### Parameters ##### props @@ -275,8 +273,6 @@ $set(props): void #### Inherited from -`SvelteComponent_1.$set` - -#### Defined in - -node_modules/.pnpm/svelte@4.2.19/node_modules/svelte/types/index.d.ts:115 +```ts +SvelteComponent_1.$set +``` diff --git a/docs/framework/svelte/reference/functions/createinfinitequery.md b/docs/framework/svelte/reference/functions/createinfinitequery.md index 144f702db9..1663c88a81 100644 --- a/docs/framework/svelte/reference/functions/createinfinitequery.md +++ b/docs/framework/svelte/reference/functions/createinfinitequery.md @@ -3,6 +3,8 @@ id: createInfiniteQuery title: createInfiniteQuery --- + + # Function: createInfiniteQuery() ```ts @@ -15,13 +17,15 @@ function createInfiniteQuery< >(options, queryClient?): CreateInfiniteQueryResult ``` +Defined in: [packages/svelte-query/src/createInfiniteQuery.ts:16](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createInfiniteQuery.ts#L16) + ## Type Parameters • **TQueryFnData** • **TError** = `Error` -• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> +• **TData** = `InfiniteData`\<`TQueryFnData`\> • **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] @@ -40,7 +44,3 @@ function createInfiniteQuery< ## Returns [`CreateInfiniteQueryResult`](../type-aliases/createinfinitequeryresult.md)\<`TData`, `TError`\> - -## Defined in - -[packages/svelte-query/src/createInfiniteQuery.ts:16](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createInfiniteQuery.ts#L16) diff --git a/docs/framework/svelte/reference/functions/createmutation.md b/docs/framework/svelte/reference/functions/createmutation.md index a9a4edfba1..9acd3054a0 100644 --- a/docs/framework/svelte/reference/functions/createmutation.md +++ b/docs/framework/svelte/reference/functions/createmutation.md @@ -3,6 +3,8 @@ id: createMutation title: createMutation --- + + # Function: createMutation() ```ts @@ -12,6 +14,8 @@ function createMutation( ): CreateMutationResult ``` +Defined in: [packages/svelte-query/src/createMutation.ts:13](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createMutation.ts#L13) + ## Type Parameters • **TData** = `unknown` @@ -35,7 +39,3 @@ function createMutation( ## Returns [`CreateMutationResult`](../type-aliases/createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TContext`\> - -## Defined in - -[packages/svelte-query/src/createMutation.ts:13](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createMutation.ts#L13) diff --git a/docs/framework/svelte/reference/functions/createqueries.md b/docs/framework/svelte/reference/functions/createqueries.md index eb29cc7857..f3db69b670 100644 --- a/docs/framework/svelte/reference/functions/createqueries.md +++ b/docs/framework/svelte/reference/functions/createqueries.md @@ -3,6 +3,8 @@ id: createQueries title: createQueries --- + + # Function: createQueries() ```ts @@ -12,11 +14,13 @@ function createQueries( ): Readable ``` +Defined in: [packages/svelte-query/src/createQueries.ts:205](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQueries.ts#L205) + ## Type Parameters • **T** _extends_ `any`[] -• **TCombinedResult** = `T` _extends_ [] ? [] : `T` _extends_ [`Head`] ? [`GetCreateQueryResult`\<`Head`\>] : `T` _extends_ [`Head`, `...Tails[]`] ? [`...Tails[]`] _extends_ [] ? [] : [`...Tails[]`] _extends_ [`Head`] ? [`GetCreateQueryResult`\<`Head`\>, `GetCreateQueryResult`\<`Head`\>] : [`...Tails[]`] _extends_ [`Head`, `...Tails[]`] ? [`...Tails[]`] _extends_ [] ? [] : [`...Tails[]`] _extends_ [`Head`] ? [`GetCreateQueryResult`\<`Head`\>, `GetCreateQueryResult`\<`Head`\>, `GetCreateQueryResult`\<`Head`\>] : [`...Tails[]`] _extends_ [`Head`, `...Tails[]`] ? [`...(...)[]`] _extends_ [] ? [] : ... _extends_ ... ? ... : ... : [`...(...)[]`] _extends_ ...[] ? ...[] : ...[] : [`...Tails[]`] _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`[] +• **TCombinedResult** = `T` _extends_ \[\] ? \[\] : `T` _extends_ \[`Head`\] ? \[`GetCreateQueryResult`\<`Head`\>\] : `T` _extends_ \[`Head`, `...Tails[]`\] ? \[`...Tails[]`\] _extends_ \[\] ? \[\] : \[`...Tails[]`\] _extends_ \[`Head`\] ? \[`GetCreateQueryResult`\<`Head`\>, `GetCreateQueryResult`\<`Head`\>\] : \[`...Tails[]`\] _extends_ \[`Head`, `...Tails[]`\] ? \[`...Tails[]`\] _extends_ \[\] ? \[\] : \[`...Tails[]`\] _extends_ \[`Head`\] ? \[`GetCreateQueryResult`\<`Head`\>, `GetCreateQueryResult`\<`Head`\>, `GetCreateQueryResult`\<`Head`\>\] : \[`...Tails[]`\] _extends_ \[`Head`, `...Tails[]`\] ? \[`...(...)[]`\] _extends_ \[\] ? \[\] : ... _extends_ ... ? ... : ... : \[`...(...)[]`\] _extends_ ...[] ? ...[] : ...[] : \[`...Tails[]`\] _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`[] ## Parameters @@ -28,7 +32,7 @@ function createQueries( #### queries -[`StoreOrVal`](../type-aliases/storeorval.md)\<[`...(T extends [] ? [] : T extends [Head] ? [GetQueryObserverOptionsForCreateQueries] : T extends [Head, ...Tails[]] ? [...Tails[]] extends [] ? [] : [...Tails[]] extends [Head] ? [GetQueryObserverOptionsForCreateQueries, GetQueryObserverOptionsForCreateQueries] : [...Tails[]] extends [Head, ...Tails[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[])[]`]\> +[`StoreOrVal`](../type-aliases/storeorval.md)\<\[`...(T extends [] ? [] : T extends [Head] ? [GetQueryObserverOptionsForCreateQueries] : T extends [Head, ...Tails[]] ? [...Tails[]] extends [] ? [] : [...Tails[]] extends [Head] ? [GetQueryObserverOptionsForCreateQueries, GetQueryObserverOptionsForCreateQueries] : [...Tails[]] extends [Head, ...Tails[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[])[]`\]\> ### queryClient? @@ -37,7 +41,3 @@ function createQueries( ## Returns `Readable`\<`TCombinedResult`\> - -## Defined in - -[packages/svelte-query/src/createQueries.ts:205](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQueries.ts#L205) diff --git a/docs/framework/svelte/reference/functions/createquery.md b/docs/framework/svelte/reference/functions/createquery.md index 67a02a2127..9369c68227 100644 --- a/docs/framework/svelte/reference/functions/createquery.md +++ b/docs/framework/svelte/reference/functions/createquery.md @@ -3,6 +3,8 @@ id: createQuery title: createQuery --- + + # Function: createQuery() ## Call Signature @@ -14,6 +16,8 @@ function createQuery( ): DefinedCreateQueryResult ``` +Defined in: [packages/svelte-query/src/createQuery.ts:15](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQuery.ts#L15) + ### Type Parameters • **TQueryFnData** = `unknown` @@ -38,10 +42,6 @@ function createQuery( [`DefinedCreateQueryResult`](../type-aliases/definedcreatequeryresult.md)\<`TData`, `TError`\> -### Defined in - -[packages/svelte-query/src/createQuery.ts:15](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQuery.ts#L15) - ## Call Signature ```ts @@ -51,6 +51,8 @@ function createQuery( ): CreateQueryResult ``` +Defined in: [packages/svelte-query/src/createQuery.ts:27](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQuery.ts#L27) + ### Type Parameters • **TQueryFnData** = `unknown` @@ -75,10 +77,6 @@ function createQuery( [`CreateQueryResult`](../type-aliases/createqueryresult.md)\<`TData`, `TError`\> -### Defined in - -[packages/svelte-query/src/createQuery.ts:27](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQuery.ts#L27) - ## Call Signature ```ts @@ -88,6 +86,8 @@ function createQuery( ): CreateQueryResult ``` +Defined in: [packages/svelte-query/src/createQuery.ts:39](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQuery.ts#L39) + ### Type Parameters • **TQueryFnData** = `unknown` @@ -111,7 +111,3 @@ function createQuery( ### Returns [`CreateQueryResult`](../type-aliases/createqueryresult.md)\<`TData`, `TError`\> - -### Defined in - -[packages/svelte-query/src/createQuery.ts:39](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQuery.ts#L39) diff --git a/docs/framework/svelte/reference/functions/getisrestoringcontext.md b/docs/framework/svelte/reference/functions/getisrestoringcontext.md index 923a433775..61f9fdfe41 100644 --- a/docs/framework/svelte/reference/functions/getisrestoringcontext.md +++ b/docs/framework/svelte/reference/functions/getisrestoringcontext.md @@ -3,18 +3,18 @@ id: getIsRestoringContext title: getIsRestoringContext --- + + # Function: getIsRestoringContext() ```ts function getIsRestoringContext(): Readable ``` +Defined in: [packages/svelte-query/src/context.ts:28](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/context.ts#L28) + Retrieves a `isRestoring` from Svelte's context ## Returns `Readable`\<`boolean`\> - -## Defined in - -[packages/svelte-query/src/context.ts:28](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/context.ts#L28) diff --git a/docs/framework/svelte/reference/functions/getqueryclientcontext.md b/docs/framework/svelte/reference/functions/getqueryclientcontext.md index 8d34ab100c..bcd13eded9 100644 --- a/docs/framework/svelte/reference/functions/getqueryclientcontext.md +++ b/docs/framework/svelte/reference/functions/getqueryclientcontext.md @@ -3,18 +3,18 @@ id: getQueryClientContext title: getQueryClientContext --- + + # Function: getQueryClientContext() ```ts function getQueryClientContext(): QueryClient ``` +Defined in: [packages/svelte-query/src/context.ts:9](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/context.ts#L9) + Retrieves a Client from Svelte's context ## Returns `QueryClient` - -## Defined in - -[packages/svelte-query/src/context.ts:9](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/context.ts#L9) diff --git a/docs/framework/svelte/reference/functions/infinitequeryoptions.md b/docs/framework/svelte/reference/functions/infinitequeryoptions.md index bbba66452f..dd13c3a4e8 100644 --- a/docs/framework/svelte/reference/functions/infinitequeryoptions.md +++ b/docs/framework/svelte/reference/functions/infinitequeryoptions.md @@ -3,6 +3,8 @@ id: infiniteQueryOptions title: infiniteQueryOptions --- + + # Function: infiniteQueryOptions() ```ts @@ -24,13 +26,15 @@ function infiniteQueryOptions< > ``` +Defined in: [packages/svelte-query/src/infiniteQueryOptions.ts:4](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/infiniteQueryOptions.ts#L4) + ## Type Parameters • **TQueryFnData** • **TError** = `Error` -• **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> +• **TData** = `InfiniteData`\<`TQueryFnData`\> • **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] @@ -45,7 +49,3 @@ function infiniteQueryOptions< ## Returns [`CreateInfiniteQueryOptions`](../type-aliases/createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\> - -## Defined in - -[packages/svelte-query/src/infiniteQueryOptions.ts:4](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/infiniteQueryOptions.ts#L4) diff --git a/docs/framework/svelte/reference/functions/queryoptions.md b/docs/framework/svelte/reference/functions/queryoptions.md index a10f4bcf92..f0126b4b79 100644 --- a/docs/framework/svelte/reference/functions/queryoptions.md +++ b/docs/framework/svelte/reference/functions/queryoptions.md @@ -3,6 +3,8 @@ id: queryOptions title: queryOptions --- + + # Function: queryOptions() ## Call Signature @@ -13,6 +15,8 @@ function queryOptions( ): DefinedInitialDataOptions & object ``` +Defined in: [packages/svelte-query/src/queryOptions.ts:31](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L31) + ### Type Parameters • **TQueryFnData** = `unknown` @@ -33,10 +37,6 @@ function queryOptions( [`DefinedInitialDataOptions`](../type-aliases/definedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` -### Defined in - -[packages/svelte-query/src/queryOptions.ts:31](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L31) - ## Call Signature ```ts @@ -45,6 +45,8 @@ function queryOptions( ): UndefinedInitialDataOptions & object ``` +Defined in: [packages/svelte-query/src/queryOptions.ts:42](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L42) + ### Type Parameters • **TQueryFnData** = `unknown` @@ -64,7 +66,3 @@ function queryOptions( ### Returns [`UndefinedInitialDataOptions`](../type-aliases/undefinedinitialdataoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`\> & `object` - -### Defined in - -[packages/svelte-query/src/queryOptions.ts:42](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L42) diff --git a/docs/framework/svelte/reference/functions/setisrestoringcontext.md b/docs/framework/svelte/reference/functions/setisrestoringcontext.md index 95555d77cb..dff63c1b99 100644 --- a/docs/framework/svelte/reference/functions/setisrestoringcontext.md +++ b/docs/framework/svelte/reference/functions/setisrestoringcontext.md @@ -3,12 +3,16 @@ id: setIsRestoringContext title: setIsRestoringContext --- + + # Function: setIsRestoringContext() ```ts function setIsRestoringContext(isRestoring): void ``` +Defined in: [packages/svelte-query/src/context.ts:40](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/context.ts#L40) + Sets a `isRestoring` on Svelte's context ## Parameters @@ -20,7 +24,3 @@ Sets a `isRestoring` on Svelte's context ## Returns `void` - -## Defined in - -[packages/svelte-query/src/context.ts:40](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/context.ts#L40) diff --git a/docs/framework/svelte/reference/functions/setqueryclientcontext.md b/docs/framework/svelte/reference/functions/setqueryclientcontext.md index 22caba70a8..04dec33cd7 100644 --- a/docs/framework/svelte/reference/functions/setqueryclientcontext.md +++ b/docs/framework/svelte/reference/functions/setqueryclientcontext.md @@ -3,12 +3,16 @@ id: setQueryClientContext title: setQueryClientContext --- + + # Function: setQueryClientContext() ```ts function setQueryClientContext(client): void ``` +Defined in: [packages/svelte-query/src/context.ts:21](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/context.ts#L21) + Sets a QueryClient on Svelte's context ## Parameters @@ -20,7 +24,3 @@ Sets a QueryClient on Svelte's context ## Returns `void` - -## Defined in - -[packages/svelte-query/src/context.ts:21](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/context.ts#L21) diff --git a/docs/framework/svelte/reference/functions/usehydrate.md b/docs/framework/svelte/reference/functions/usehydrate.md index f85bde0c3e..66697969cc 100644 --- a/docs/framework/svelte/reference/functions/usehydrate.md +++ b/docs/framework/svelte/reference/functions/usehydrate.md @@ -3,12 +3,16 @@ id: useHydrate title: useHydrate --- + + # Function: useHydrate() ```ts function useHydrate(state?, options?, queryClient?): void ``` +Defined in: [packages/svelte-query/src/useHydrate.ts:5](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useHydrate.ts#L5) + ## Parameters ### state? @@ -26,7 +30,3 @@ function useHydrate(state?, options?, queryClient?): void ## Returns `void` - -## Defined in - -[packages/svelte-query/src/useHydrate.ts:5](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useHydrate.ts#L5) diff --git a/docs/framework/svelte/reference/functions/useisfetching.md b/docs/framework/svelte/reference/functions/useisfetching.md index 8796d61bef..e8e482af7e 100644 --- a/docs/framework/svelte/reference/functions/useisfetching.md +++ b/docs/framework/svelte/reference/functions/useisfetching.md @@ -3,17 +3,21 @@ id: useIsFetching title: useIsFetching --- + + # Function: useIsFetching() ```ts function useIsFetching(filters?, queryClient?): Readable ``` +Defined in: [packages/svelte-query/src/useIsFetching.ts:7](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useIsFetching.ts#L7) + ## Parameters ### filters? -`QueryFilters`\<`unknown`, `Error`, `unknown`, readonly `unknown`[]\> +`QueryFilters` ### queryClient? @@ -22,7 +26,3 @@ function useIsFetching(filters?, queryClient?): Readable ## Returns `Readable`\<`number`\> - -## Defined in - -[packages/svelte-query/src/useIsFetching.ts:7](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useIsFetching.ts#L7) diff --git a/docs/framework/svelte/reference/functions/useismutating.md b/docs/framework/svelte/reference/functions/useismutating.md index a2773004ab..48e8a0718e 100644 --- a/docs/framework/svelte/reference/functions/useismutating.md +++ b/docs/framework/svelte/reference/functions/useismutating.md @@ -3,17 +3,21 @@ id: useIsMutating title: useIsMutating --- + + # Function: useIsMutating() ```ts function useIsMutating(filters?, queryClient?): Readable ``` +Defined in: [packages/svelte-query/src/useIsMutating.ts:7](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useIsMutating.ts#L7) + ## Parameters ### filters? -`MutationFilters`\<`unknown`, `Error`, `unknown`, `unknown`\> +`MutationFilters` ### queryClient? @@ -22,7 +26,3 @@ function useIsMutating(filters?, queryClient?): Readable ## Returns `Readable`\<`number`\> - -## Defined in - -[packages/svelte-query/src/useIsMutating.ts:7](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useIsMutating.ts#L7) diff --git a/docs/framework/svelte/reference/functions/useisrestoring.md b/docs/framework/svelte/reference/functions/useisrestoring.md index 5bebc77087..f459ca541d 100644 --- a/docs/framework/svelte/reference/functions/useisrestoring.md +++ b/docs/framework/svelte/reference/functions/useisrestoring.md @@ -3,16 +3,16 @@ id: useIsRestoring title: useIsRestoring --- + + # Function: useIsRestoring() ```ts function useIsRestoring(): Readable ``` +Defined in: [packages/svelte-query/src/useIsRestoring.ts:4](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useIsRestoring.ts#L4) + ## Returns `Readable`\<`boolean`\> - -## Defined in - -[packages/svelte-query/src/useIsRestoring.ts:4](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useIsRestoring.ts#L4) diff --git a/docs/framework/svelte/reference/functions/usemutationstate.md b/docs/framework/svelte/reference/functions/usemutationstate.md index f335bebf99..b23a3cc465 100644 --- a/docs/framework/svelte/reference/functions/usemutationstate.md +++ b/docs/framework/svelte/reference/functions/usemutationstate.md @@ -3,15 +3,19 @@ id: useMutationState title: useMutationState --- + + # Function: useMutationState() ```ts function useMutationState(options, queryClient?): Readable ``` +Defined in: [packages/svelte-query/src/useMutationState.ts:24](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useMutationState.ts#L24) + ## Type Parameters -• **TResult** = `MutationState`\<`unknown`, `Error`, `unknown`, `unknown`\> +• **TResult** = `MutationState` ## Parameters @@ -26,7 +30,3 @@ function useMutationState(options, queryClient?): Readable ## Returns `Readable`\<`TResult`[]\> - -## Defined in - -[packages/svelte-query/src/useMutationState.ts:24](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useMutationState.ts#L24) diff --git a/docs/framework/svelte/reference/functions/usequeryclient.md b/docs/framework/svelte/reference/functions/usequeryclient.md index 2a962408ca..1af8cbb23f 100644 --- a/docs/framework/svelte/reference/functions/usequeryclient.md +++ b/docs/framework/svelte/reference/functions/usequeryclient.md @@ -3,12 +3,16 @@ id: useQueryClient title: useQueryClient --- + + # Function: useQueryClient() ```ts function useQueryClient(queryClient?): QueryClient ``` +Defined in: [packages/svelte-query/src/useQueryClient.ts:4](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useQueryClient.ts#L4) + ## Parameters ### queryClient? @@ -18,7 +22,3 @@ function useQueryClient(queryClient?): QueryClient ## Returns `QueryClient` - -## Defined in - -[packages/svelte-query/src/useQueryClient.ts:4](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/useQueryClient.ts#L4) diff --git a/docs/framework/svelte/reference/index.md b/docs/framework/svelte/reference/index.md index 8b50592d89..1ad2dd281d 100644 --- a/docs/framework/svelte/reference/index.md +++ b/docs/framework/svelte/reference/index.md @@ -3,6 +3,8 @@ id: '@tanstack/svelte-query' title: '@tanstack/svelte-query' --- + + # @tanstack/svelte-query ## References diff --git a/docs/framework/svelte/reference/type-aliases/createbasemutationresult.md b/docs/framework/svelte/reference/type-aliases/createbasemutationresult.md index 9d51cbc3b2..7a26b01e91 100644 --- a/docs/framework/svelte/reference/type-aliases/createbasemutationresult.md +++ b/docs/framework/svelte/reference/type-aliases/createbasemutationresult.md @@ -3,6 +3,8 @@ id: CreateBaseMutationResult title: CreateBaseMutationResult --- + + # Type Alias: CreateBaseMutationResult\ ```ts @@ -15,6 +17,8 @@ type CreateBaseMutationResult = Override< object ``` +Defined in: [packages/svelte-query/src/types.ts:114](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L114) + ## Type declaration ### mutateAsync @@ -32,7 +36,3 @@ mutateAsync: CreateMutateAsyncFunction • **TVariables** = `unknown` • **TContext** = `unknown` - -## Defined in - -[packages/svelte-query/src/types.ts:114](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L114) diff --git a/docs/framework/svelte/reference/type-aliases/createbasequeryoptions.md b/docs/framework/svelte/reference/type-aliases/createbasequeryoptions.md index 17aa6e9ed3..cfce0dd33f 100644 --- a/docs/framework/svelte/reference/type-aliases/createbasequeryoptions.md +++ b/docs/framework/svelte/reference/type-aliases/createbasequeryoptions.md @@ -3,6 +3,8 @@ id: CreateBaseQueryOptions title: CreateBaseQueryOptions --- + + # Type Alias: CreateBaseQueryOptions\ ```ts @@ -15,6 +17,8 @@ type CreateBaseQueryOptions< > = QueryObserverOptions ``` +Defined in: [packages/svelte-query/src/types.ts:24](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L24) + Options for createBaseQuery ## Type Parameters @@ -28,7 +32,3 @@ Options for createBaseQuery • **TQueryData** = `TQueryFnData` • **TQueryKey** _extends_ `QueryKey` = `QueryKey` - -## Defined in - -[packages/svelte-query/src/types.ts:24](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L24) diff --git a/docs/framework/svelte/reference/type-aliases/createbasequeryresult.md b/docs/framework/svelte/reference/type-aliases/createbasequeryresult.md index 67f649cd71..894028045c 100644 --- a/docs/framework/svelte/reference/type-aliases/createbasequeryresult.md +++ b/docs/framework/svelte/reference/type-aliases/createbasequeryresult.md @@ -3,6 +3,8 @@ id: CreateBaseQueryResult title: CreateBaseQueryResult --- + + # Type Alias: CreateBaseQueryResult\ ```ts @@ -11,6 +13,8 @@ type CreateBaseQueryResult = Readable< > ``` +Defined in: [packages/svelte-query/src/types.ts:33](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L33) + Result from createBaseQuery ## Type Parameters @@ -18,7 +22,3 @@ Result from createBaseQuery • **TData** = `unknown` • **TError** = `DefaultError` - -## Defined in - -[packages/svelte-query/src/types.ts:33](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L33) diff --git a/docs/framework/svelte/reference/type-aliases/createinfinitequeryoptions.md b/docs/framework/svelte/reference/type-aliases/createinfinitequeryoptions.md index 674fe7801a..1ac5f08c93 100644 --- a/docs/framework/svelte/reference/type-aliases/createinfinitequeryoptions.md +++ b/docs/framework/svelte/reference/type-aliases/createinfinitequeryoptions.md @@ -3,6 +3,8 @@ id: CreateInfiniteQueryOptions title: CreateInfiniteQueryOptions --- + + # Type Alias: CreateInfiniteQueryOptions\ ```ts @@ -23,6 +25,8 @@ type CreateInfiniteQueryOptions< > ``` +Defined in: [packages/svelte-query/src/types.ts:53](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L53) + Options for createInfiniteQuery ## Type Parameters @@ -38,7 +42,3 @@ Options for createInfiniteQuery • **TQueryKey** _extends_ `QueryKey` = `QueryKey` • **TPageParam** = `unknown` - -## Defined in - -[packages/svelte-query/src/types.ts:53](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L53) diff --git a/docs/framework/svelte/reference/type-aliases/createinfinitequeryresult.md b/docs/framework/svelte/reference/type-aliases/createinfinitequeryresult.md index 07ec8c90ce..90e40bba6e 100644 --- a/docs/framework/svelte/reference/type-aliases/createinfinitequeryresult.md +++ b/docs/framework/svelte/reference/type-aliases/createinfinitequeryresult.md @@ -3,6 +3,8 @@ id: CreateInfiniteQueryResult title: CreateInfiniteQueryResult --- + + # Type Alias: CreateInfiniteQueryResult\ ```ts @@ -11,6 +13,8 @@ type CreateInfiniteQueryResult = Readable< > ``` +Defined in: [packages/svelte-query/src/types.ts:70](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L70) + Result from createInfiniteQuery ## Type Parameters @@ -18,7 +22,3 @@ Result from createInfiniteQuery • **TData** = `unknown` • **TError** = `DefaultError` - -## Defined in - -[packages/svelte-query/src/types.ts:70](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L70) diff --git a/docs/framework/svelte/reference/type-aliases/createmutateasyncfunction.md b/docs/framework/svelte/reference/type-aliases/createmutateasyncfunction.md index 31162afcd4..fb26197304 100644 --- a/docs/framework/svelte/reference/type-aliases/createmutateasyncfunction.md +++ b/docs/framework/svelte/reference/type-aliases/createmutateasyncfunction.md @@ -3,6 +3,8 @@ id: CreateMutateAsyncFunction title: CreateMutateAsyncFunction --- + + # Type Alias: CreateMutateAsyncFunction\ ```ts @@ -10,6 +12,8 @@ type CreateMutateAsyncFunction = MutateFunction ``` +Defined in: [packages/svelte-query/src/types.ts:107](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L107) + ## Type Parameters • **TData** = `unknown` @@ -19,7 +23,3 @@ type CreateMutateAsyncFunction = • **TVariables** = `void` • **TContext** = `unknown` - -## Defined in - -[packages/svelte-query/src/types.ts:107](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L107) diff --git a/docs/framework/svelte/reference/type-aliases/createmutatefunction.md b/docs/framework/svelte/reference/type-aliases/createmutatefunction.md index 277affff10..7632e1c644 100644 --- a/docs/framework/svelte/reference/type-aliases/createmutatefunction.md +++ b/docs/framework/svelte/reference/type-aliases/createmutatefunction.md @@ -3,6 +3,8 @@ id: CreateMutateFunction title: CreateMutateFunction --- + + # Type Alias: CreateMutateFunction()\ ```ts @@ -11,6 +13,8 @@ type CreateMutateFunction = ( ) => void ``` +Defined in: [packages/svelte-query/src/types.ts:98](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L98) + ## Type Parameters • **TData** = `unknown` @@ -30,7 +34,3 @@ type CreateMutateFunction = ( ## Returns `void` - -## Defined in - -[packages/svelte-query/src/types.ts:98](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L98) diff --git a/docs/framework/svelte/reference/type-aliases/createmutationoptions.md b/docs/framework/svelte/reference/type-aliases/createmutationoptions.md index 6f1fd3ab96..a1b2a1e5b4 100644 --- a/docs/framework/svelte/reference/type-aliases/createmutationoptions.md +++ b/docs/framework/svelte/reference/type-aliases/createmutationoptions.md @@ -3,6 +3,8 @@ id: CreateMutationOptions title: CreateMutationOptions --- + + # Type Alias: CreateMutationOptions\ ```ts @@ -12,6 +14,8 @@ type CreateMutationOptions = OmitKeyof< > ``` +Defined in: [packages/svelte-query/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L88) + Options for createMutation ## Type Parameters @@ -23,7 +27,3 @@ Options for createMutation • **TVariables** = `void` • **TContext** = `unknown` - -## Defined in - -[packages/svelte-query/src/types.ts:88](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L88) diff --git a/docs/framework/svelte/reference/type-aliases/createmutationresult.md b/docs/framework/svelte/reference/type-aliases/createmutationresult.md index 9e6fae8dbb..b6cefeb909 100644 --- a/docs/framework/svelte/reference/type-aliases/createmutationresult.md +++ b/docs/framework/svelte/reference/type-aliases/createmutationresult.md @@ -3,6 +3,8 @@ id: CreateMutationResult title: CreateMutationResult --- + + # Type Alias: CreateMutationResult\ ```ts @@ -11,6 +13,8 @@ type CreateMutationResult = Readable< > ``` +Defined in: [packages/svelte-query/src/types.ts:127](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L127) + Result from createMutation ## Type Parameters @@ -22,7 +26,3 @@ Result from createMutation • **TVariables** = `unknown` • **TContext** = `unknown` - -## Defined in - -[packages/svelte-query/src/types.ts:127](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L127) diff --git a/docs/framework/svelte/reference/type-aliases/createqueryoptions.md b/docs/framework/svelte/reference/type-aliases/createqueryoptions.md index dd46abd078..8ca32aefcf 100644 --- a/docs/framework/svelte/reference/type-aliases/createqueryoptions.md +++ b/docs/framework/svelte/reference/type-aliases/createqueryoptions.md @@ -3,6 +3,8 @@ id: CreateQueryOptions title: CreateQueryOptions --- + + # Type Alias: CreateQueryOptions\ ```ts @@ -10,6 +12,8 @@ type CreateQueryOptions = CreateBaseQueryOptions ``` +Defined in: [packages/svelte-query/src/types.ts:39](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L39) + Options for createQuery ## Type Parameters @@ -21,7 +25,3 @@ Options for createQuery • **TData** = `TQueryFnData` • **TQueryKey** _extends_ `QueryKey` = `QueryKey` - -## Defined in - -[packages/svelte-query/src/types.ts:39](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L39) diff --git a/docs/framework/svelte/reference/type-aliases/createqueryresult.md b/docs/framework/svelte/reference/type-aliases/createqueryresult.md index 5be421869b..6888a6ccd0 100644 --- a/docs/framework/svelte/reference/type-aliases/createqueryresult.md +++ b/docs/framework/svelte/reference/type-aliases/createqueryresult.md @@ -3,12 +3,16 @@ id: CreateQueryResult title: CreateQueryResult --- + + # Type Alias: CreateQueryResult\ ```ts type CreateQueryResult = CreateBaseQueryResult ``` +Defined in: [packages/svelte-query/src/types.ts:47](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L47) + Result from createQuery ## Type Parameters @@ -16,7 +20,3 @@ Result from createQuery • **TData** = `unknown` • **TError** = `DefaultError` - -## Defined in - -[packages/svelte-query/src/types.ts:47](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L47) diff --git a/docs/framework/svelte/reference/type-aliases/definedcreatebasequeryresult.md b/docs/framework/svelte/reference/type-aliases/definedcreatebasequeryresult.md index abdf5c35af..31b0d7389a 100644 --- a/docs/framework/svelte/reference/type-aliases/definedcreatebasequeryresult.md +++ b/docs/framework/svelte/reference/type-aliases/definedcreatebasequeryresult.md @@ -3,6 +3,8 @@ id: DefinedCreateBaseQueryResult title: DefinedCreateBaseQueryResult --- + + # Type Alias: DefinedCreateBaseQueryResult\ ```ts @@ -11,6 +13,8 @@ type DefinedCreateBaseQueryResult = Readable< > ``` +Defined in: [packages/svelte-query/src/types.ts:76](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L76) + Options for createBaseQuery with initialData ## Type Parameters @@ -18,7 +22,3 @@ Options for createBaseQuery with initialData • **TData** = `unknown` • **TError** = `DefaultError` - -## Defined in - -[packages/svelte-query/src/types.ts:76](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L76) diff --git a/docs/framework/svelte/reference/type-aliases/definedcreatequeryresult.md b/docs/framework/svelte/reference/type-aliases/definedcreatequeryresult.md index aef2cc962e..28201419a4 100644 --- a/docs/framework/svelte/reference/type-aliases/definedcreatequeryresult.md +++ b/docs/framework/svelte/reference/type-aliases/definedcreatequeryresult.md @@ -3,6 +3,8 @@ id: DefinedCreateQueryResult title: DefinedCreateQueryResult --- + + # Type Alias: DefinedCreateQueryResult\ ```ts @@ -12,6 +14,8 @@ type DefinedCreateQueryResult = DefinedCreateBaseQueryResult< > ``` +Defined in: [packages/svelte-query/src/types.ts:82](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L82) + Options for createQuery with initialData ## Type Parameters @@ -19,7 +23,3 @@ Options for createQuery with initialData • **TData** = `unknown` • **TError** = `DefaultError` - -## Defined in - -[packages/svelte-query/src/types.ts:82](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L82) diff --git a/docs/framework/svelte/reference/type-aliases/definedinitialdataoptions.md b/docs/framework/svelte/reference/type-aliases/definedinitialdataoptions.md index dc2066626f..fd669dc2b2 100644 --- a/docs/framework/svelte/reference/type-aliases/definedinitialdataoptions.md +++ b/docs/framework/svelte/reference/type-aliases/definedinitialdataoptions.md @@ -3,6 +3,8 @@ id: DefinedInitialDataOptions title: DefinedInitialDataOptions --- + + # Type Alias: DefinedInitialDataOptions\ ```ts @@ -10,6 +12,8 @@ type DefinedInitialDataOptions = CreateQueryOptions & object ``` +Defined in: [packages/svelte-query/src/queryOptions.ts:20](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L20) + ## Type declaration ### initialData @@ -29,7 +33,3 @@ initialData: • **TData** = `TQueryFnData` • **TQueryKey** _extends_ `QueryKey` = `QueryKey` - -## Defined in - -[packages/svelte-query/src/queryOptions.ts:20](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L20) diff --git a/docs/framework/svelte/reference/type-aliases/mutationstateoptions.md b/docs/framework/svelte/reference/type-aliases/mutationstateoptions.md index b6fe8a2042..a697e81a12 100644 --- a/docs/framework/svelte/reference/type-aliases/mutationstateoptions.md +++ b/docs/framework/svelte/reference/type-aliases/mutationstateoptions.md @@ -3,12 +3,16 @@ id: MutationStateOptions title: MutationStateOptions --- + + # Type Alias: MutationStateOptions\ ```ts type MutationStateOptions = object ``` +Defined in: [packages/svelte-query/src/types.ts:135](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L135) + Options for useMutationState ## Type Parameters @@ -38,7 +42,3 @@ optional select: (mutation) => TResult; #### Returns `TResult` - -## Defined in - -[packages/svelte-query/src/types.ts:135](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L135) diff --git a/docs/framework/svelte/reference/type-aliases/queriesoptions.md b/docs/framework/svelte/reference/type-aliases/queriesoptions.md index 926c8abbdd..e1a6d90284 100644 --- a/docs/framework/svelte/reference/type-aliases/queriesoptions.md +++ b/docs/framework/svelte/reference/type-aliases/queriesoptions.md @@ -3,6 +3,8 @@ id: QueriesOptions title: QueriesOptions --- + + # Type Alias: QueriesOptions\ ```ts @@ -36,16 +38,14 @@ type QueriesOptions = : QueryObserverOptionsForCreateQueries[] ``` +Defined in: [packages/svelte-query/src/createQueries.ts:129](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQueries.ts#L129) + QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param ## Type Parameters • **T** _extends_ `any`[] -• **TResults** _extends_ `any`[] = [] - -• **TDepth** _extends_ `ReadonlyArray`\<`number`\> = [] - -## Defined in +• **TResults** _extends_ `any`[] = \[\] -[packages/svelte-query/src/createQueries.ts:129](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQueries.ts#L129) +• **TDepth** _extends_ `ReadonlyArray`\<`number`\> = \[\] diff --git a/docs/framework/svelte/reference/type-aliases/queriesresults.md b/docs/framework/svelte/reference/type-aliases/queriesresults.md index 248bfb39a9..b318fa949d 100644 --- a/docs/framework/svelte/reference/type-aliases/queriesresults.md +++ b/docs/framework/svelte/reference/type-aliases/queriesresults.md @@ -3,6 +3,8 @@ id: QueriesResults title: QueriesResults --- + + # Type Alias: QueriesResults\ ```ts @@ -32,16 +34,14 @@ type QueriesResults = : QueryObserverResult[] ``` +Defined in: [packages/svelte-query/src/createQueries.ts:171](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQueries.ts#L171) + QueriesResults reducer recursively maps type param to results ## Type Parameters • **T** _extends_ `any`[] -• **TResults** _extends_ `any`[] = [] - -• **TDepth** _extends_ `ReadonlyArray`\<`number`\> = [] - -## Defined in +• **TResults** _extends_ `any`[] = \[\] -[packages/svelte-query/src/createQueries.ts:171](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/createQueries.ts#L171) +• **TDepth** _extends_ `ReadonlyArray`\<`number`\> = \[\] diff --git a/docs/framework/svelte/reference/type-aliases/storeorval.md b/docs/framework/svelte/reference/type-aliases/storeorval.md index fc38d49b6d..fdab5e498f 100644 --- a/docs/framework/svelte/reference/type-aliases/storeorval.md +++ b/docs/framework/svelte/reference/type-aliases/storeorval.md @@ -3,18 +3,18 @@ id: StoreOrVal title: StoreOrVal --- + + # Type Alias: StoreOrVal\ ```ts type StoreOrVal = T | Readable ``` +Defined in: [packages/svelte-query/src/types.ts:21](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L21) + Allows a type to be either the base object or a store of that object ## Type Parameters • **T** - -## Defined in - -[packages/svelte-query/src/types.ts:21](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/types.ts#L21) diff --git a/docs/framework/svelte/reference/type-aliases/undefinedinitialdataoptions.md b/docs/framework/svelte/reference/type-aliases/undefinedinitialdataoptions.md index 865ccff6f7..20d5c6c386 100644 --- a/docs/framework/svelte/reference/type-aliases/undefinedinitialdataoptions.md +++ b/docs/framework/svelte/reference/type-aliases/undefinedinitialdataoptions.md @@ -3,6 +3,8 @@ id: UndefinedInitialDataOptions title: UndefinedInitialDataOptions --- + + # Type Alias: UndefinedInitialDataOptions\ ```ts @@ -10,6 +12,8 @@ type UndefinedInitialDataOptions = CreateQueryOptions & object ``` +Defined in: [packages/svelte-query/src/queryOptions.ts:9](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L9) + ## Type declaration ### initialData? @@ -27,7 +31,3 @@ optional initialData: InitialDataFunction>; • **TData** = `TQueryFnData` • **TQueryKey** _extends_ `QueryKey` = `QueryKey` - -## Defined in - -[packages/svelte-query/src/queryOptions.ts:9](https://github.com/TanStack/query/blob/main/packages/svelte-query/src/queryOptions.ts#L9) diff --git a/package.json b/package.json index 675a2916dd..8a42c5a73b 100644 --- a/package.json +++ b/package.json @@ -40,7 +40,7 @@ "@arethetypeswrong/cli": "^0.15.3", "@cspell/eslint-plugin": "^8.17.1", "@eslint-react/eslint-plugin": "^1.19.0", - "@tanstack/config": "^0.14.2", + "@tanstack/config": "^0.16.0", "@testing-library/jest-dom": "^6.6.3", "@types/eslint": "^9.6.1", "@types/node": "^22.9.3", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 5dc5adfe39..3d4d6afa60 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -4751,8 +4751,8 @@ packages: resolution: {integrity: sha512-tMTqrY+EzbXmKJR5ToI8lxu7jaN5EdmrBFJpQk5JmSlyLsx6o4t27r883K5xsLuCYCpfKBCGswMSWXsM+jB7lg==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} - '@eslint/js@9.17.0': - resolution: {integrity: sha512-Sxc4hqcs1kTu0iID3kcZDW3JHq2a77HO9P8CP6YEA/FpH3Ll8UXE2r/86Rz9YJLKme39S9vU5OWNjC6Xl0Cr3w==} + '@eslint/js@9.18.0': + resolution: {integrity: sha512-fK6L7rxcq6/z+AaQMtiFTkvbHkBLNlwyRxHpKawP0x3u9+NC6MQTnFW+AdpwC6gfHTW0051cokQgtTN2FqlxQA==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} '@eslint/object-schema@2.1.4': @@ -6888,57 +6888,57 @@ packages: '@types/yargs@17.0.33': resolution: {integrity: sha512-WpxBCKWPLr4xSsHgz511rFJAM+wS28w2zEO1QDNY5zM/S8ok70NNfztH0xwhqKyaK0OHCbN98LDAZuy1ctxDkA==} - '@typescript-eslint/eslint-plugin@8.18.1': - resolution: {integrity: sha512-Ncvsq5CT3Gvh+uJG0Lwlho6suwDfUXH0HztslDf5I+F2wAFAZMRwYLEorumpKLzmO2suAXZ/td1tBg4NZIi9CQ==} + '@typescript-eslint/eslint-plugin@8.20.0': + resolution: {integrity: sha512-naduuphVw5StFfqp4Gq4WhIBE2gN1GEmMUExpJYknZJdRnc+2gDzB8Z3+5+/Kv33hPQRDGzQO/0opHE72lZZ6A==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} peerDependencies: '@typescript-eslint/parser': ^8.0.0 || ^8.0.0-alpha.0 eslint: ^8.57.0 || ^9.0.0 typescript: '>=4.8.4 <5.8.0' - '@typescript-eslint/parser@8.18.1': - resolution: {integrity: sha512-rBnTWHCdbYM2lh7hjyXqxk70wvon3p2FyaniZuey5TrcGBpfhVp0OxOa6gxr9Q9YhZFKyfbEnxc24ZnVbbUkCA==} + '@typescript-eslint/parser@8.20.0': + resolution: {integrity: sha512-gKXG7A5HMyjDIedBi6bUrDcun8GIjnI8qOwVLiY3rx6T/sHP/19XLJOnIq/FgQvWLHja5JN/LSE7eklNBr612g==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} peerDependencies: eslint: ^8.57.0 || ^9.0.0 typescript: '>=4.8.4 <5.8.0' - '@typescript-eslint/rule-tester@8.18.1': - resolution: {integrity: sha512-Ri73SSfOfd+aESELU2k0ikpIahTSY1VVsGiFWarDy54HSuMMZc/2JCST0dfpRep3egAvcI5/lcQvRHmSyzcA4g==} + '@typescript-eslint/rule-tester@8.20.0': + resolution: {integrity: sha512-4Lg9dZY6ghXkecSmEfKvBySyx35krbtJtJZ53IT0fDh8WWZislP8QI38rWKSz8eB530YlBH+Tn0uhlLfhD+5vA==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} peerDependencies: eslint: ^8.57.0 || ^9.0.0 - '@typescript-eslint/scope-manager@8.18.1': - resolution: {integrity: sha512-HxfHo2b090M5s2+/9Z3gkBhI6xBH8OJCFjH9MhQ+nnoZqxU3wNxkLT+VWXWSFWc3UF3Z+CfPAyqdCTdoXtDPCQ==} + '@typescript-eslint/scope-manager@8.20.0': + resolution: {integrity: sha512-J7+VkpeGzhOt3FeG1+SzhiMj9NzGD/M6KoGn9f4dbz3YzK9hvbhVTmLj/HiTp9DazIzJ8B4XcM80LrR9Dm1rJw==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} - '@typescript-eslint/type-utils@8.18.1': - resolution: {integrity: sha512-jAhTdK/Qx2NJPNOTxXpMwlOiSymtR2j283TtPqXkKBdH8OAMmhiUfP0kJjc/qSE51Xrq02Gj9NY7MwK+UxVwHQ==} + '@typescript-eslint/type-utils@8.20.0': + resolution: {integrity: sha512-bPC+j71GGvA7rVNAHAtOjbVXbLN5PkwqMvy1cwGeaxUoRQXVuKCebRoLzm+IPW/NtFFpstn1ummSIasD5t60GA==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} peerDependencies: eslint: ^8.57.0 || ^9.0.0 typescript: '>=4.8.4 <5.8.0' - '@typescript-eslint/types@8.18.1': - resolution: {integrity: sha512-7uoAUsCj66qdNQNpH2G8MyTFlgerum8ubf21s3TSM3XmKXuIn+H2Sifh/ES2nPOPiYSRJWAk0fDkW0APBWcpfw==} + '@typescript-eslint/types@8.20.0': + resolution: {integrity: sha512-cqaMiY72CkP+2xZRrFt3ExRBu0WmVitN/rYPZErA80mHjHx/Svgp8yfbzkJmDoQ/whcytOPO9/IZXnOc+wigRA==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} - '@typescript-eslint/typescript-estree@8.18.1': - resolution: {integrity: sha512-z8U21WI5txzl2XYOW7i9hJhxoKKNG1kcU4RzyNvKrdZDmbjkmLBo8bgeiOJmA06kizLI76/CCBAAGlTlEeUfyg==} + '@typescript-eslint/typescript-estree@8.20.0': + resolution: {integrity: sha512-Y7ncuy78bJqHI35NwzWol8E0X7XkRVS4K4P4TCyzWkOJih5NDvtoRDW4Ba9YJJoB2igm9yXDdYI/+fkiiAxPzA==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} peerDependencies: typescript: '>=4.8.4 <5.8.0' - '@typescript-eslint/utils@8.18.1': - resolution: {integrity: sha512-8vikiIj2ebrC4WRdcAdDcmnu9Q/MXXwg+STf40BVfT8exDqBCUPdypvzcUPxEqRGKg9ALagZ0UWcYCtn+4W2iQ==} + '@typescript-eslint/utils@8.20.0': + resolution: {integrity: sha512-dq70RUw6UK9ei7vxc4KQtBRk7qkHZv447OUZ6RPQMQl71I3NZxQJX/f32Smr+iqWrB02pHKn2yAdHBb0KNrRMA==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} peerDependencies: eslint: ^8.57.0 || ^9.0.0 typescript: '>=4.8.4 <5.8.0' - '@typescript-eslint/visitor-keys@8.18.1': - resolution: {integrity: sha512-Vj0WLm5/ZsD013YeUKn+K0y8p1M0jPpxOkKdbD1wB0ns53a5piVY02zjf072TblEweAbcYiFiPoSMF3kp+VhhQ==} + '@typescript-eslint/visitor-keys@8.20.0': + resolution: {integrity: sha512-v/BpkeeYAsPkKCkR8BDwcno0llhzWVqPOamQrAEMdpZav2Y9OVjd9dwJyBLJWwf335B5DmlifECIkZRJCaGaHA==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} '@ungap/structured-clone@1.2.0': @@ -7739,9 +7739,6 @@ packages: '@babel/core': ^7.12.0 webpack: '>=5' - babel-plugin-add-module-exports@0.2.1: - resolution: {integrity: sha512-3AN/9V/rKuv90NG65m4tTHsI04XrCKsWbztIcW7a8H5iIN7WlvWucRtVV0V/rT4QvtA11n5Vmp20fLwfMWqp6g==} - babel-plugin-istanbul@6.1.1: resolution: {integrity: sha512-Y1IQok9821cC9onCx5otgFfRm7Lm+I+wwxOx738M/WLPZ9Q42m4IG5W0FNX8WLL2gYMZo3JkuXIH2DOpWM+qwA==} engines: {node: '>=8'} @@ -8326,6 +8323,10 @@ packages: resolution: {integrity: sha512-Vw8qHK3bZM9y/P10u3Vib8o/DdkvA2OtPtZvD871QKjy74Wj1WSKFILMPRPSdUSx5RFK1arlJzEtA4PkFgnbuA==} engines: {node: '>=18'} + commander@13.0.0: + resolution: {integrity: sha512-oPYleIY8wmTVzkvQq10AEok6YcTC4sRUBl8F9gVuwchGVUCTbl/vhLTaQqutuuySYOsu8YTgV+OxKc/8Yvx+mQ==} + engines: {node: '>=18'} + commander@2.20.3: resolution: {integrity: sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==} @@ -8554,9 +8555,6 @@ packages: cross-fetch@3.1.8: resolution: {integrity: sha512-cvA+JwZoU0Xq+h6WkMvAUqPEYy92Obet6UdKLfW60qn99ftItKjB5T+BkyWOFWe2pUyfQ+IJHmpOTznqk1M6Kg==} - cross-spawn@5.1.0: - resolution: {integrity: sha512-pTgQJ5KC0d2hcY8eyL1IzlBPYjTkyH72XRZPnLyKus2mBfNjQs3klqbJU2VILqZryAZUt9JOb3h/mWMy23/f5A==} - cross-spawn@6.0.5: resolution: {integrity: sha512-eTVLrBSt7fjbDygz805pMnstIs2VTBNkRm0qxZd+M7A5XDdxVRWO5MxGBXZhjY4cqLYLdtrGqRf8mBPmzwSpWQ==} engines: {node: '>=4.8'} @@ -8650,9 +8648,6 @@ packages: csstype@3.1.3: resolution: {integrity: sha512-M1uQkMl8rQK/szD0LNhtqxIPLpimGm8sOBwU7lLnCpSbTyY3yeU1Vc7l4KT5zT4s/yOxHH5O7tIuuLOCnLADRw==} - current-git-branch@1.1.0: - resolution: {integrity: sha512-n5mwGZllLsFzxDPtTmadqGe4IIBPfqPbiIRX4xgFR9VK/Bx47U+94KiVkxSKAKN6/s43TlkztS2GZpgMKzwQ8A==} - cyclist@1.0.2: resolution: {integrity: sha512-0sVXIohTfLqVIW3kb/0n6IiWF3Ifj5nm2XaSrLq2DI6fKIGa2fYAZdk917rUneaeLVpYfFcyXE2ft0fe3remsA==} @@ -9210,8 +9205,8 @@ packages: peerDependencies: eslint: ^7.0.0 || ^8.0.0 || ^9.0.0 - eslint-plugin-n@17.14.0: - resolution: {integrity: sha512-maxPLMEA0rPmRpoOlxEclKng4UpDe+N5BJS4t24I3UKnN109Qcivnfs37KMy84G0af3bxjog5lKctP5ObsvcTA==} + eslint-plugin-n@17.15.1: + resolution: {integrity: sha512-KFw7x02hZZkBdbZEFQduRGH4VkIH4MW97ClsbAM4Y4E6KguBJWGfWG1P4HEIpZk2bkoWf0bojpnjNAhYQP8beA==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} peerDependencies: eslint: '>=8.23.0' @@ -9407,10 +9402,6 @@ packages: exec-async@2.2.0: resolution: {integrity: sha512-87OpwcEiMia/DeiKFzaQNBNFeN3XkkpYIh9FyOqq5mS2oKv3CBE67PXoEKcr6nodWdXNogTiQ0jE2NGuoffXPw==} - execa@0.6.3: - resolution: {integrity: sha512-/teX3MDLFBdYUhRk8WCBYboIMUmqeizu0m9Z3YF3JWrbEh/SlZg00vLJSaAGWw3wrZ9tE0buNw79eaAPYhUuvg==} - engines: {node: '>=4'} - execa@1.0.0: resolution: {integrity: sha512-adbxcyWV46qiHyvSp50TKt05tB4tK3HcmF7/nxfAdhnox83seTDbwnaqKO4sXRy7roHAIFqJP/Rw/AuEbX61LA==} engines: {node: '>=6'} @@ -9852,10 +9843,6 @@ packages: resolution: {integrity: sha512-x5UJKlgeUiNT8nyo/AcnwLnZuZNcSjSw0kogRB+Whd1fjjFq4B1hySFxSFWWSn4mIBzg3sRNUDFYc4g5gjPoLg==} engines: {node: '>=4'} - get-stream@3.0.0: - resolution: {integrity: sha512-GlhdIUuVakc8SJ6kK0zAFbiGzRFzNnY4jUuEbV9UROo4Y+0Ny4fjvcZFVTeDA4odpFyOQzaw6hXukJSq/f28sQ==} - engines: {node: '>=4'} - get-stream@4.1.0: resolution: {integrity: sha512-GMat4EJ5161kIy2HevLlr4luNjBgvmj413KaQA7jt4V8B4RDsfpHk7WQ9GVqfYyyx8OS/L66Kox+rJRNklLK7w==} engines: {node: '>=6'} @@ -10535,9 +10522,6 @@ packages: resolution: {integrity: sha512-OVa3u9kkBbw7b8Xw5F9P+D/T9X+Z4+JruYVNapTjPYZYUznQ5YfWeFkOj606XYYW8yugTfC8Pj0hYqvi4ryAhA==} engines: {node: '>=18'} - is-git-repository@1.1.1: - resolution: {integrity: sha512-hxLpJytJnIZ5Og5QsxSkzmb8Qx8rGau9bio1JN/QtXcGEFuSsQYau0IiqlsCwftsfVYjF1mOq6uLdmwNSspgpA==} - is-glob@3.1.0: resolution: {integrity: sha512-UFpDDrPgM6qpnFNI+rh/p3bUaq9hKLZN8bMUWzxmcnZVS3omf4IPK+BrewlnWjO1WmUsMYuSjKh4UJuV4+Lqmw==} engines: {node: '>=0.10.0'} @@ -11331,9 +11315,6 @@ packages: lru-cache@10.4.3: resolution: {integrity: sha512-JNAzZcXrCt42VGLuYz0zfAzDfAvJWW6AfYlDBQyDV5DClI2m5sAmK+OIO7s59XfsRsWHp02jAJrRadPRGTt6SQ==} - lru-cache@4.1.5: - resolution: {integrity: sha512-sWZlbEP2OsHNkXrMl5GYk/jKk70MBng6UU4YI/qGDYbgf6YbP4EvmqISbXCoJiRKs+1bSpFHVgQxvJ17F2li5g==} - lru-cache@5.1.1: resolution: {integrity: sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w==} @@ -12915,9 +12896,6 @@ packages: prr@1.0.1: resolution: {integrity: sha512-yPw4Sng1gWghHQWj0B3ZggWUm4qVbPwPFcRG8KyxiU7J2OHFSoEHKS+EZ3fv5l1t9CyCiop6l/ZYeWbrgoQejw==} - pseudomap@1.0.2: - resolution: {integrity: sha512-b/YwNhb8lk1Zz2+bXXpS/LK9OisiZZ1SNsSLxN1x2OXVEhW2Ckr/7mWE5vrC1ZTiJlD9g19jWszTmJsB+oEpFQ==} - psl@1.9.0: resolution: {integrity: sha512-E/ZsdU4HLs/68gYzgGTkMicWTLPdAftJLfJFlLUAAKZGkStNU72sZjT66SnMDVOfOWY/YAoiD7Jxa9iHvngcag==} @@ -14530,6 +14508,12 @@ packages: peerDependencies: typescript: '>=4.2.0' + ts-api-utils@2.0.0: + resolution: {integrity: sha512-xCt/TOAc+EOHS1XPnijD3/yzpH6qg2xppZO1YDqGoVsNXfQfzHpOdNuXwrwOU8u4ITXJyDCTyt8w5g1sZv9ynQ==} + engines: {node: '>=18.12'} + peerDependencies: + typescript: '>=4.8.4' + ts-declaration-location@1.0.4: resolution: {integrity: sha512-r4JoxYhKULbZuH81Pjrp9OEG5St7XWk7zXwGkLKhmVcjiBVHTJXV5wK6dEa9JKW5QGSTW6b1lOjxAKp8R1SQhg==} peerDependencies: @@ -14663,14 +14647,14 @@ packages: peerDependencies: typedoc-plugin-markdown: '>=4.3.0' - typedoc-plugin-markdown@4.3.3: - resolution: {integrity: sha512-kESCcNRzOcFJATLML2FoCfaTF9c0ujmbZ+UXsJvmNlFLS3v8tDKfDifreJXvXWa9d8gUcetZqOqFcZ/7+Ba34Q==} + typedoc-plugin-markdown@4.4.1: + resolution: {integrity: sha512-fx23nSCvewI9IR8lzIYtzDphETcgTDuxKcmHKGD4lo36oexC+B1k4NaCOY58Snqb4OlE8OXDAGVcQXYYuLRCNw==} engines: {node: '>= 18'} peerDependencies: typedoc: 0.27.x - typedoc@0.27.5: - resolution: {integrity: sha512-x+fhKJtTg4ozXwKayh/ek4wxZQI/+2hmZUdO2i2NGDBRUflDble70z+ewHod3d4gRpXSO6fnlnjbDTnJk7HlkQ==} + typedoc@0.27.6: + resolution: {integrity: sha512-oBFRoh2Px6jFx366db0lLlihcalq/JzyCVp7Vaq1yphL/tbgx2e+bkpkCgJPunaPvPwoTOXSwasfklWHm7GfAw==} engines: {node: '>= 18'} hasBin: true peerDependencies: @@ -14682,8 +14666,8 @@ packages: typescript-auto-import-cache@0.3.3: resolution: {integrity: sha512-ojEC7+Ci1ij9eE6hp8Jl9VUNnsEKzztktP5gtYNRMrTmfXVwA1PITYYAkpxCvvupdSYa/Re51B6KMcv1CTZEUA==} - typescript-eslint@8.18.1: - resolution: {integrity: sha512-Mlaw6yxuaDEPQvb/2Qwu3/TfgeBHy9iTJ3mTwe7OvpPmF6KPQjVOfGyEJpPv6Ez2C34OODChhXrzYw/9phI0MQ==} + typescript-eslint@8.20.0: + resolution: {integrity: sha512-Kxz2QRFsgbWj6Xcftlw3Dd154b3cEPFqQC+qMZrMypSijPd4UanKKvoKDrJ4o8AIfZFKAF+7sMaEIR8mTElozA==} engines: {node: ^18.18.0 || ^20.9.0 || >=21.1.0} peerDependencies: eslint: ^8.57.0 || ^9.0.0 @@ -15805,9 +15789,6 @@ packages: resolution: {integrity: sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==} engines: {node: '>=10'} - yallist@2.1.2: - resolution: {integrity: sha512-ncTzHV7NvsQZkYe1DW7cbDLm0YpzHmZF5r/iyP3ZnQtMiJ+pjzisCiMNI+Sj+xQF5pXhSHxSB3uDbsBTzY/c2A==} - yallist@3.1.1: resolution: {integrity: sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g==} @@ -18185,7 +18166,7 @@ snapshots: '@eslint/js@9.15.0': {} - '@eslint/js@9.17.0': {} + '@eslint/js@9.18.0': {} '@eslint/object-schema@2.1.4': {} @@ -20804,10 +20785,10 @@ snapshots: - supports-color - typescript - '@typescript-eslint/scope-manager@8.18.1': + '@typescript-eslint/scope-manager@8.20.0': dependencies: - '@typescript-eslint/types': 8.18.1 - '@typescript-eslint/visitor-keys': 8.18.1 + '@typescript-eslint/types': 8.20.0 + '@typescript-eslint/visitor-keys': 8.20.0 '@typescript-eslint/type-utils@8.18.1(eslint@9.15.0(jiti@2.4.2))(typescript@5.8.2)': dependencies: @@ -20820,7 +20801,7 @@ snapshots: transitivePeerDependencies: - supports-color - '@typescript-eslint/types@8.18.1': {} + '@typescript-eslint/types@8.20.0': {} '@typescript-eslint/typescript-estree@8.18.1(typescript@5.8.2)': dependencies: @@ -20847,9 +20828,9 @@ snapshots: transitivePeerDependencies: - supports-color - '@typescript-eslint/visitor-keys@8.18.1': + '@typescript-eslint/visitor-keys@8.20.0': dependencies: - '@typescript-eslint/types': 8.18.1 + '@typescript-eslint/types': 8.20.0 eslint-visitor-keys: 4.2.0 '@ungap/structured-clone@1.2.0': {} @@ -22676,6 +22657,8 @@ snapshots: commander@12.1.0: {} + commander@13.0.0: {} + commander@2.20.3: {} commander@4.1.1: {} @@ -22926,12 +22909,6 @@ snapshots: transitivePeerDependencies: - encoding - cross-spawn@5.1.0: - dependencies: - lru-cache: 4.1.5 - shebang-command: 1.2.0 - which: 1.3.1 - cross-spawn@6.0.5: dependencies: nice-try: 1.0.5 @@ -23079,12 +23056,6 @@ snapshots: csstype@3.1.3: {} - current-git-branch@1.1.0: - dependencies: - babel-plugin-add-module-exports: 0.2.1 - execa: 0.6.3 - is-git-repository: 1.1.1 - cyclist@1.0.2: {} data-urls@5.0.0: @@ -24044,16 +24015,6 @@ snapshots: exec-async@2.2.0: {} - execa@0.6.3: - dependencies: - cross-spawn: 5.1.0 - get-stream: 3.0.0 - is-stream: 1.1.0 - npm-run-path: 2.0.2 - p-finally: 1.0.0 - signal-exit: 3.0.7 - strip-eof: 1.0.0 - execa@1.0.0: dependencies: cross-spawn: 6.0.5 @@ -24612,8 +24573,6 @@ snapshots: get-port@3.2.0: {} - get-stream@3.0.0: {} - get-stream@4.1.0: dependencies: pump: 3.0.2 @@ -25404,11 +25363,6 @@ snapshots: dependencies: get-east-asian-width: 1.3.0 - is-git-repository@1.1.1: - dependencies: - execa: 0.6.3 - path-is-absolute: 1.0.1 - is-glob@3.1.0: dependencies: is-extglob: 2.1.1 @@ -26289,11 +26243,6 @@ snapshots: lru-cache@10.4.3: {} - lru-cache@4.1.5: - dependencies: - pseudomap: 1.0.2 - yallist: 2.1.2 - lru-cache@5.1.1: dependencies: yallist: 3.1.1 @@ -28439,8 +28388,6 @@ snapshots: prr@1.0.1: {} - pseudomap@1.0.2: {} - psl@1.9.0: {} public-encrypt@4.0.3: @@ -31770,8 +31717,6 @@ snapshots: y18n@5.0.8: {} - yallist@2.1.2: {} - yallist@3.1.1: {} yallist@4.0.0: {} From 515cd7c0795cca230866e59eea07a02cf96eac3d Mon Sep 17 00:00:00 2001 From: "autofix-ci[bot]" <114827586+autofix-ci[bot]@users.noreply.github.com> Date: Wed, 15 Jan 2025 22:44:37 +0000 Subject: [PATCH 3/3] ci: apply automated fixes --- .../interfaces/basemutationnarrowing.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/docs/framework/angular/reference/interfaces/basemutationnarrowing.md b/docs/framework/angular/reference/interfaces/basemutationnarrowing.md index e10f54fdf2..730a1178dd 100644 --- a/docs/framework/angular/reference/interfaces/basemutationnarrowing.md +++ b/docs/framework/angular/reference/interfaces/basemutationnarrowing.md @@ -25,9 +25,7 @@ Defined in: [types.ts:218](https://github.com/TanStack/query/blob/main/packages/ ```ts isError: SignalFunction< - ( - this, - ) => this is CreateMutationResult< + (this) => this is CreateMutationResult< TData, TError, TVariables, @@ -55,9 +53,7 @@ Defined in: [types.ts:241](https://github.com/TanStack/query/blob/main/packages/ ```ts isIdle: SignalFunction< - ( - this, - ) => this is CreateMutationResult< + (this) => this is CreateMutationResult< TData, TError, TVariables, @@ -85,9 +81,7 @@ Defined in: [types.ts:275](https://github.com/TanStack/query/blob/main/packages/ ```ts isPending: SignalFunction< - ( - this, - ) => this is CreateMutationResult< + (this) => this is CreateMutationResult< TData, TError, TVariables, @@ -115,9 +109,7 @@ Defined in: [types.ts:258](https://github.com/TanStack/query/blob/main/packages/ ```ts isSuccess: SignalFunction< - ( - this, - ) => this is CreateMutationResult< + (this) => this is CreateMutationResult< TData, TError, TVariables,