Generate API reference docs

Author: arnoud-dv

docs/framework/angular/reference/functions/infinitequeryoptions.md

@@ -3,6 +3,8 @@ id: infiniteQueryOptions
 title: infiniteQueryOptions
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: infiniteQueryOptions()
 
 Allows to share and re-use infinite query options in a type-safe way.
@@ -24,16 +26,19 @@ function infiniteQueryOptions<
   TPageParam,
 >(
   options,
-): DefinedInitialDataInfiniteOptions<
+): CreateInfiniteQueryOptions<
   TQueryFnData,
   TError,
   TData,
   TQueryKey,
   TPageParam
 > &
+  object &
   object
 ```
 
+Defined in: [infinite-query-options.ts:88](https://github.com/arnoud-dv/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L88)
+
 Allows to share and re-use infinite query options in a type-safe way.
 
 The `queryKey` will be tagged with the type from `queryFn`.
@@ -60,7 +65,7 @@ The infinite query options to tag with the type from `queryFn`.
 
 ### Returns
 
-[`DefinedInitialDataInfiniteOptions`](../../type-aliases/definedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
+[`CreateInfiniteQueryOptions`](../../interfaces/createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` & `object`
 
 The tagged infinite query options.
 
@@ -70,10 +75,6 @@ The tagged infinite query options.
 
 The infinite query options to tag with the type from `queryFn`.
 
-### Defined in
-
-[infinite-query-options.ts:94](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L94)
-
 ## Call Signature
 
 ```ts
@@ -85,16 +86,22 @@ function infiniteQueryOptions<
   TPageParam,
 >(
   options,
-): UnusedSkipTokenInfiniteOptions<
-  TQueryFnData,
-  TError,
-  TData,
-  TQueryKey,
-  TPageParam
+): OmitKeyof<
+  CreateInfiniteQueryOptions<
+    TQueryFnData,
+    TError,
+    TData,
+    TQueryKey,
+    TPageParam
+  >,
+  'queryFn'
 > &
+  object &
   object
 ```
 
+Defined in: [infinite-query-options.ts:119](https://github.com/arnoud-dv/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L119)
+
 Allows to share and re-use infinite query options in a type-safe way.
 
 The `queryKey` will be tagged with the type from `queryFn`.
@@ -121,7 +128,7 @@ The infinite query options to tag with the type from `queryFn`.
 
 ### Returns
 
-[`UnusedSkipTokenInfiniteOptions`](../../type-aliases/unusedskiptokeninfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
+`OmitKeyof`\<[`CreateInfiniteQueryOptions`](../../interfaces/createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>, `"queryFn"`\> & `object` & `object`
 
 The tagged infinite query options.
 
@@ -131,10 +138,6 @@ The tagged infinite query options.
 
 The infinite query options to tag with the type from `queryFn`.
 
-### Defined in
-
-[infinite-query-options.ts:126](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L126)
-
 ## Call Signature
 
 ```ts
@@ -146,16 +149,19 @@ function infiniteQueryOptions<
   TPageParam,
 >(
   options,
-): UndefinedInitialDataInfiniteOptions<
+): CreateInfiniteQueryOptions<
   TQueryFnData,
   TError,
   TData,
   TQueryKey,
   TPageParam
 > &
+  object &
   object
 ```
 
+Defined in: [infinite-query-options.ts:150](https://github.com/arnoud-dv/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L150)
+
 Allows to share and re-use infinite query options in a type-safe way.
 
 The `queryKey` will be tagged with the type from `queryFn`.
@@ -182,7 +188,7 @@ The infinite query options to tag with the type from `queryFn`.
 
 ### Returns
 
-[`UndefinedInitialDataInfiniteOptions`](../../type-aliases/undefinedinitialdatainfiniteoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object`
+[`CreateInfiniteQueryOptions`](../../interfaces/createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\> & `object` & `object`
 
 The tagged infinite query options.
 
@@ -191,7 +197,3 @@ The tagged infinite query options.
 ### Param
 
 The infinite query options to tag with the type from `queryFn`.
-
-### Defined in
-
-[infinite-query-options.ts:158](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L158)

docs/framework/angular/reference/functions/injectinfinitequery.md

@@ -3,6 +3,8 @@ id: injectInfiniteQuery
 title: injectInfiniteQuery
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: injectInfiniteQuery()
 
 Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
@@ -31,6 +33,8 @@ function injectInfiniteQuery<
 ): DefinedCreateInfiniteQueryResult<TData, TError>
 ```
 
+Defined in: [inject-infinite-query.ts:41](https://github.com/arnoud-dv/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L41)
+
 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"
 
@@ -76,10 +80,6 @@ A function that returns infinite query options.
 
 Additional configuration.
 
-### Defined in
-
-[inject-infinite-query.ts:42](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L42)
-
 ## Call Signature
 
 ```ts
@@ -92,6 +92,8 @@ function injectInfiniteQuery<
 >(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
 ```
 
+Defined in: [inject-infinite-query.ts:65](https://github.com/arnoud-dv/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L65)
+
 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"
 
@@ -137,10 +139,6 @@ A function that returns infinite query options.
 
 Additional configuration.
 
-### Defined in
-
-[inject-infinite-query.ts:67](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L67)
-
 ## Call Signature
 
 ```ts
@@ -153,6 +151,8 @@ function injectInfiniteQuery<
 >(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult<TData, TError>
 ```
 
+Defined in: [inject-infinite-query.ts:89](https://github.com/arnoud-dv/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L89)
+
 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"
 
@@ -172,7 +172,7 @@ Infinite queries can additively "load more" data onto an existing set of data or
 
 #### injectInfiniteQueryFn
 
-() => [`CreateInfiniteQueryOptions`](../../interfaces/createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryFnData`, `TQueryKey`, `TPageParam`\>
+() => [`CreateInfiniteQueryOptions`](../../interfaces/createinfinitequeryoptions.md)\<`TQueryFnData`, `TError`, `TData`, `TQueryKey`, `TPageParam`\>
 
 A function that returns infinite query options.
 
@@ -197,7 +197,3 @@ A function that returns infinite query options.
 ### Param
 
 Additional configuration.
-
-### Defined in
-
-[inject-infinite-query.ts:92](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L92)

docs/framework/angular/reference/functions/injectisfetching.md

@@ -3,12 +3,16 @@ id: injectIsFetching
 title: injectIsFetching
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: injectIsFetching()
 
 ```ts
 function injectIsFetching(filters?, options?): Signal<number>
 ```
 
+Defined in: [inject-is-fetching.ts:32](https://github.com/arnoud-dv/query/blob/main/packages/angular-query-experimental/src/inject-is-fetching.ts#L32)
+
 Injects a signal that tracks the number of queries that your application is loading or
 fetching in the background.
 
@@ -33,7 +37,3 @@ Additional configuration
 `Signal`\<`number`\>
 
 signal with number of loading or fetching queries.
-
-## Defined in
-
-[inject-is-fetching.ts:32](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-fetching.ts#L32)

docs/framework/angular/reference/functions/injectismutating.md

@@ -3,12 +3,16 @@ id: injectIsMutating
 title: injectIsMutating
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: injectIsMutating()
 
 ```ts
 function injectIsMutating(filters?, options?): Signal<number>
 ```
 
+Defined in: [inject-is-mutating.ts:30](https://github.com/arnoud-dv/query/blob/main/packages/angular-query-experimental/src/inject-is-mutating.ts#L30)
+
 Injects a signal that tracks the number of mutations that your application is fetching.
 
 Can be used for app-wide loading indicators
@@ -32,7 +36,3 @@ Additional configuration
 `Signal`\<`number`\>
 
 signal with number of fetching mutations.
-
-## Defined in
-
-[inject-is-mutating.ts:31](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-mutating.ts#L31)

docs/framework/angular/reference/functions/injectisrestoring.md

@@ -3,12 +3,16 @@ id: injectIsRestoring
 title: injectIsRestoring
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: injectIsRestoring()
 
 ```ts
 function injectIsRestoring(options?): Signal<boolean>
 ```
 
+Defined in: [inject-is-restoring.ts:32](https://github.com/arnoud-dv/query/blob/main/packages/angular-query-experimental/src/inject-is-restoring.ts#L32)
+
 Injects a signal that tracks whether a restore is currently in progress. [injectQuery](../injectquery.md) and friends also check this internally to avoid race conditions between the restore and initializing queries.
 
 ## Parameters
@@ -23,8 +27,4 @@ Options for injectIsRestoring.
 
 `Signal`\<`boolean`\>
 
-signal with boolean that indicates whether a restore is in progress.
-
-## Defined in
-
-[inject-is-restoring.ts:35](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-restoring.ts#L35)
+readonly signal with boolean that indicates whether a restore is in progress.

docs/framework/angular/reference/functions/injectmutation.md

@@ -3,6 +3,8 @@ id: injectMutation
 title: injectMutation
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: injectMutation()
 
 ```ts
@@ -12,6 +14,8 @@ function injectMutation<TData, TError, TVariables, TContext>(
 ): CreateMutationResult<TData, TError, TVariables, TContext>
 ```
 
+Defined in: [inject-mutation.ts:41](https://github.com/arnoud-dv/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L41)
+
 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 @@ Additional configuration
 [`CreateMutationResult`](../../type-aliases/createmutationresult.md)\<`TData`, `TError`, `TVariables`, `TContext`\>
 
 The mutation.
-
-## Defined in
-
-[inject-mutation.ts:42](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L42)

docs/framework/angular/reference/functions/injectmutationstate.md

@@ -3,6 +3,8 @@ id: injectMutationState
 title: injectMutationState
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: injectMutationState()
 
 ```ts
@@ -12,6 +14,8 @@ function injectMutationState<TResult>(
 ): Signal<TResult[]>
 ```
 
+Defined in: [inject-mutation-state.ts:60](https://github.com/arnoud-dv/query/blob/main/packages/angular-query-experimental/src/inject-mutation-state.ts#L60)
+
 Injects a signal that tracks the state of all mutations.
 
 ## Type 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:64](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation-state.ts#L64)

docs/framework/angular/reference/functions/injectqueries.md

@@ -3,32 +3,36 @@ id: injectQueries
 title: injectQueries
 ---
 
+<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
+
 # Function: injectQueries()
 
 ```ts
 function injectQueries<T, TCombinedResult>(
-  __namedParameters,
+  root0,
   injector?,
 ): Signal<TCombinedResult>
 ```
 
+Defined in: [inject-queries.ts:202](https://github.com/arnoud-dv/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L202)
+
 ## 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
 
-### \_\_namedParameters
+### root0
 
-#### combine
+#### combine?
 
 (`result`) => `TCombinedResult`
 
 #### queries
 
-`Signal`\<[`...(T extends [] ? [] : T extends [Head] ? [GetOptions<Head>] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>[] ? QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>[] : QueryObserverOptionsForCreateQueries<unknown, Error, unknown, readonly (...)[]>[])[]`]\>
+`Signal`\<\[`...(T extends [] ? [] : T extends [Head] ? [GetOptions<Head>] : T extends [Head, ...Tail[]] ? [...Tail[]] extends [] ? [] : [...Tail[]] extends [Head] ? [GetOptions<Head>, GetOptions<Head>] : [...Tail[]] extends [Head, ...Tail[]] ? [...(...)[]] extends [] ? [] : (...) extends (...) ? (...) : (...) : readonly (...)[] extends [...(...)[]] ? [...(...)[]] : (...) extends (...) ? (...) : (...) : readonly unknown[] extends T ? T : T extends QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>[] ? QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData, TQueryKey>[] : QueryObserverOptionsForCreateQueries<unknown, Error, unknown, readonly (...)[]>[])[]`\]\>
 
 ### injector?
 
@@ -37,7 +41,3 @@ function injectQueries<T, TCombinedResult>(
 ## Returns
 
 `Signal`\<`TCombinedResult`\>
-
-## Defined in
-
-[inject-queries.ts:206](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L206)