diff --git a/.changeset/devtools-feature-rename.md b/.changeset/devtools-feature-rename.md new file mode 100644 index 0000000000..f23859ccc1 --- /dev/null +++ b/.changeset/devtools-feature-rename.md @@ -0,0 +1,5 @@ +--- +'@tanstack/angular-query-experimental': patch +--- + +Rename `DeveloperToolsFeature` to `DevtoolsFeature` for consistency with internal naming conventions and ecosystem \ No newline at end of file diff --git a/.prettierignore b/.prettierignore index d750389515..d1bb5343b0 100644 --- a/.prettierignore +++ b/.prettierignore @@ -9,3 +9,4 @@ pnpm-lock.yaml packages/**/tsup.config.bundled*.mjs **/tsconfig.vitest-temp.json +docs/framework/*/reference diff --git a/docs/framework/angular/reference/functions/infinitequeryoptions.md b/docs/framework/angular/reference/functions/infinitequeryoptions.md index 4f7055f247..ac83ec422c 100644 --- a/docs/framework/angular/reference/functions/infinitequeryoptions.md +++ b/docs/framework/angular/reference/functions/infinitequeryoptions.md @@ -18,23 +18,7 @@ The infinite query options to tag with the type from `queryFn`. ## Call Signature ```ts -function infiniteQueryOptions< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam, ->( - options, -): CreateInfiniteQueryOptions< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam -> & - object & - object +function infiniteQueryOptions(options): CreateInfiniteQueryOptions & object & object ``` Defined in: [infinite-query-options.ts:88](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L88) @@ -51,7 +35,7 @@ The `queryKey` will be tagged with the type from `queryFn`. • **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> -• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] +• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[] • **TPageParam** = `unknown` @@ -78,26 +62,7 @@ The infinite query options to tag with the type from `queryFn`. ## Call Signature ```ts -function infiniteQueryOptions< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam, ->( - options, -): OmitKeyof< - CreateInfiniteQueryOptions< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam - >, - 'queryFn' -> & - object & - object +function infiniteQueryOptions(options): OmitKeyof, "queryFn"> & object & object ``` Defined in: [infinite-query-options.ts:119](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L119) @@ -114,7 +79,7 @@ The `queryKey` will be tagged with the type from `queryFn`. • **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> -• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] +• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[] • **TPageParam** = `unknown` @@ -141,23 +106,7 @@ The infinite query options to tag with the type from `queryFn`. ## Call Signature ```ts -function infiniteQueryOptions< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam, ->( - options, -): CreateInfiniteQueryOptions< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam -> & - object & - object +function infiniteQueryOptions(options): CreateInfiniteQueryOptions & object & object ``` Defined in: [infinite-query-options.ts:150](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L150) @@ -174,7 +123,7 @@ The `queryKey` will be tagged with the type from `queryFn`. • **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> -• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] +• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[] • **TPageParam** = `unknown` diff --git a/docs/framework/angular/reference/functions/injectinfinitequery.md b/docs/framework/angular/reference/functions/injectinfinitequery.md index a8dff3e877..dc8a1d88da 100644 --- a/docs/framework/angular/reference/functions/injectinfinitequery.md +++ b/docs/framework/angular/reference/functions/injectinfinitequery.md @@ -21,16 +21,7 @@ Additional configuration. ## Call Signature ```ts -function injectInfiniteQuery< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam, ->( - injectInfiniteQueryFn, - options?, -): DefinedCreateInfiniteQueryResult +function injectInfiniteQuery(injectInfiniteQueryFn, options?): DefinedCreateInfiniteQueryResult ``` Defined in: [inject-infinite-query.ts:41](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L41) @@ -46,7 +37,7 @@ Infinite queries can additively "load more" data onto an existing set of data or • **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> -• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] +• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[] • **TPageParam** = `unknown` @@ -83,13 +74,7 @@ Additional configuration. ## Call Signature ```ts -function injectInfiniteQuery< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam, ->(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult +function injectInfiniteQuery(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult ``` Defined in: [inject-infinite-query.ts:65](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L65) @@ -105,7 +90,7 @@ Infinite queries can additively "load more" data onto an existing set of data or • **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> -• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] +• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[] • **TPageParam** = `unknown` @@ -142,13 +127,7 @@ Additional configuration. ## Call Signature ```ts -function injectInfiniteQuery< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam, ->(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult +function injectInfiniteQuery(injectInfiniteQueryFn, options?): CreateInfiniteQueryResult ``` Defined in: [inject-infinite-query.ts:89](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-infinite-query.ts#L89) @@ -164,7 +143,7 @@ Infinite queries can additively "load more" data onto an existing set of data or • **TData** = `InfiniteData`\<`TQueryFnData`, `unknown`\> -• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] +• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[] • **TPageParam** = `unknown` diff --git a/docs/framework/angular/reference/functions/injectisfetching.md b/docs/framework/angular/reference/functions/injectisfetching.md index 14555e20a0..518763cbbe 100644 --- a/docs/framework/angular/reference/functions/injectisfetching.md +++ b/docs/framework/angular/reference/functions/injectisfetching.md @@ -11,7 +11,7 @@ title: injectIsFetching function injectIsFetching(filters?, options?): Signal ``` -Defined in: [inject-is-fetching.ts:32](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-fetching.ts#L32) +Defined in: [inject-is-fetching.ts:31](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-is-fetching.ts#L31) Injects a signal that tracks the number of queries that your application is loading or fetching in the background. diff --git a/docs/framework/angular/reference/functions/injectmutation.md b/docs/framework/angular/reference/functions/injectmutation.md index 8a18f6d36c..a18e34b5b1 100644 --- a/docs/framework/angular/reference/functions/injectmutation.md +++ b/docs/framework/angular/reference/functions/injectmutation.md @@ -8,13 +8,10 @@ title: injectMutation # Function: injectMutation() ```ts -function injectMutation( - injectMutationFn, - options?, -): CreateMutationResult +function injectMutation(injectMutationFn, options?): CreateMutationResult ``` -Defined in: [inject-mutation.ts:44](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L44) +Defined in: [inject-mutation.ts:45](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L45) Injects a mutation: an imperative function that can be invoked which typically performs server side effects. diff --git a/docs/framework/angular/reference/functions/injectmutationstate.md b/docs/framework/angular/reference/functions/injectmutationstate.md index 67f5d3d1bf..2b37544ec4 100644 --- a/docs/framework/angular/reference/functions/injectmutationstate.md +++ b/docs/framework/angular/reference/functions/injectmutationstate.md @@ -8,10 +8,7 @@ title: injectMutationState # Function: injectMutationState() ```ts -function injectMutationState( - injectMutationStateFn, - options?, -): Signal +function injectMutationState(injectMutationStateFn, options?): Signal ``` Defined in: [inject-mutation-state.ts:60](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation-state.ts#L60) diff --git a/docs/framework/angular/reference/functions/injectqueries.md b/docs/framework/angular/reference/functions/injectqueries.md deleted file mode 100644 index bc78ac6c4c..0000000000 --- a/docs/framework/angular/reference/functions/injectqueries.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -id: injectQueries -title: injectQueries ---- - - - -# Function: injectQueries() - -```ts -function injectQueries( - root0, - injector?, -): Signal -``` - -Defined in: [inject-queries.ts:202](https://github.com/TanStack/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`[] - -## Parameters - -### root0 - -#### combine? - -(`result`) => `TCombinedResult` - -#### 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 - -`Signal`\<`TCombinedResult`\> diff --git a/docs/framework/angular/reference/functions/injectquery.md b/docs/framework/angular/reference/functions/injectquery.md index 289eb21fc0..c57f44e32e 100644 --- a/docs/framework/angular/reference/functions/injectquery.md +++ b/docs/framework/angular/reference/functions/injectquery.md @@ -10,7 +10,6 @@ title: injectQuery Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key. **Basic example** - ```ts class ServiceOrComponent { query = injectQuery(() => ({ @@ -26,7 +25,6 @@ In the example below, the query will be automatically enabled and executed when to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled. **Reactive example** - ```ts class ServiceOrComponent { filter = signal('') @@ -55,10 +53,7 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries ## Call Signature ```ts -function injectQuery( - injectQueryFn, - options?, -): DefinedCreateQueryResult +function injectQuery(injectQueryFn, options?): DefinedCreateQueryResult ``` Defined in: [inject-query.ts:65](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L65) @@ -66,7 +61,6 @@ Defined in: [inject-query.ts:65](https://github.com/TanStack/query/blob/main/pac Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key. **Basic example** - ```ts class ServiceOrComponent { query = injectQuery(() => ({ @@ -82,7 +76,6 @@ In the example below, the query will be automatically enabled and executed when to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled. **Reactive example** - ```ts class ServiceOrComponent { filter = signal('') @@ -104,7 +97,7 @@ class ServiceOrComponent { • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] +• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[] ### Parameters @@ -147,10 +140,7 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries ## Call Signature ```ts -function injectQuery( - injectQueryFn, - options?, -): CreateQueryResult +function injectQuery(injectQueryFn, options?): CreateQueryResult ``` Defined in: [inject-query.ts:116](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L116) @@ -158,7 +148,6 @@ Defined in: [inject-query.ts:116](https://github.com/TanStack/query/blob/main/pa Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key. **Basic example** - ```ts class ServiceOrComponent { query = injectQuery(() => ({ @@ -174,7 +163,6 @@ In the example below, the query will be automatically enabled and executed when to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled. **Reactive example** - ```ts class ServiceOrComponent { filter = signal('') @@ -196,7 +184,7 @@ class ServiceOrComponent { • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] +• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[] ### Parameters @@ -239,10 +227,7 @@ https://tanstack.com/query/latest/docs/framework/angular/guides/queries ## Call Signature ```ts -function injectQuery( - injectQueryFn, - options?, -): CreateQueryResult +function injectQuery(injectQueryFn, options?): CreateQueryResult ``` Defined in: [inject-query.ts:167](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query.ts#L167) @@ -250,7 +235,6 @@ Defined in: [inject-query.ts:167](https://github.com/TanStack/query/blob/main/pa Injects a query: a declarative dependency on an asynchronous source of data that is tied to a unique key. **Basic example** - ```ts class ServiceOrComponent { query = injectQuery(() => ({ @@ -266,7 +250,6 @@ In the example below, the query will be automatically enabled and executed when to a truthy value. When the filter signal changes back to a falsy value, the query will be disabled. **Reactive example** - ```ts class ServiceOrComponent { filter = signal('') @@ -288,7 +271,7 @@ class ServiceOrComponent { • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] +• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[] ### Parameters diff --git a/docs/framework/angular/reference/functions/injectqueryclient.md b/docs/framework/angular/reference/functions/injectqueryclient.md index a5450f4dcf..e036aedfba 100644 --- a/docs/framework/angular/reference/functions/injectqueryclient.md +++ b/docs/framework/angular/reference/functions/injectqueryclient.md @@ -35,7 +35,6 @@ Use `inject(QueryClient)` instead. If you need to get a `QueryClient` from a custom injector, use `injector.get(QueryClient)`. **Example** - ```ts -const queryClient = injectQueryClient() +const queryClient = injectQueryClient(); ``` diff --git a/docs/framework/angular/reference/functions/mutationoptions.md b/docs/framework/angular/reference/functions/mutationoptions.md index 0284da3771..d167704d8f 100644 --- a/docs/framework/angular/reference/functions/mutationoptions.md +++ b/docs/framework/angular/reference/functions/mutationoptions.md @@ -14,16 +14,17 @@ Allows to share and re-use mutation options in a type-safe way. ```ts export class QueriesService { private http = inject(HttpClient) + private queryClient = inject(QueryClient) updatePost(id: number) { return mutationOptions({ mutationFn: (post: Post) => Promise.resolve(post), - mutationKey: ['updatePost', id], + mutationKey: ["updatePost", id], onSuccess: (newPost) => { // ^? newPost: Post - this.queryClient.setQueryData(['posts', id], newPost) + this.queryClient.setQueryData(["posts", id], newPost) }, - }) + }); } } @@ -45,15 +46,10 @@ The mutation options. ## Call Signature ```ts -function mutationOptions( - options, -): WithRequired< - CreateMutationOptions, - 'mutationKey' -> +function mutationOptions(options): WithRequired, "mutationKey"> ``` -Defined in: [mutation-options.ts:38](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/mutation-options.ts#L38) +Defined in: [mutation-options.ts:39](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/mutation-options.ts#L39) Allows to share and re-use mutation options in a type-safe way. @@ -62,16 +58,17 @@ Allows to share and re-use mutation options in a type-safe way. ```ts export class QueriesService { private http = inject(HttpClient) + private queryClient = inject(QueryClient) updatePost(id: number) { return mutationOptions({ mutationFn: (post: Post) => Promise.resolve(post), - mutationKey: ['updatePost', id], + mutationKey: ["updatePost", id], onSuccess: (newPost) => { // ^? newPost: Post - this.queryClient.setQueryData(['posts', id], newPost) + this.queryClient.setQueryData(["posts", id], newPost) }, - }) + }); } } @@ -119,15 +116,10 @@ The mutation options. ## Call Signature ```ts -function mutationOptions( - options, -): Omit< - CreateMutationOptions, - 'mutationKey' -> +function mutationOptions(options): Omit, "mutationKey"> ``` -Defined in: [mutation-options.ts:52](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/mutation-options.ts#L52) +Defined in: [mutation-options.ts:53](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/mutation-options.ts#L53) Allows to share and re-use mutation options in a type-safe way. @@ -136,16 +128,17 @@ Allows to share and re-use mutation options in a type-safe way. ```ts export class QueriesService { private http = inject(HttpClient) + private queryClient = inject(QueryClient) updatePost(id: number) { return mutationOptions({ mutationFn: (post: Post) => Promise.resolve(post), - mutationKey: ['updatePost', id], + mutationKey: ["updatePost", id], onSuccess: (newPost) => { // ^? newPost: Post - this.queryClient.setQueryData(['posts', id], newPost) + this.queryClient.setQueryData(["posts", id], newPost) }, - }) + }); } } diff --git a/docs/framework/angular/reference/functions/providetanstackquery.md b/docs/framework/angular/reference/functions/providetanstackquery.md index b70abdf030..2a5a2070cb 100644 --- a/docs/framework/angular/reference/functions/providetanstackquery.md +++ b/docs/framework/angular/reference/functions/providetanstackquery.md @@ -49,7 +49,6 @@ 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, @@ -76,7 +75,6 @@ export const MY_QUERY_CLIENT = new InjectionToken('', { // In a lazy loaded route or lazy loaded component's providers array: providers: [provideTanStackQuery(MY_QUERY_CLIENT)] ``` - Using an InjectionToken for the QueryClient is an advanced optimization which allows TanStack Query to be absent from the main application bundle. This can be beneficial if you want to include TanStack Query on lazy loaded routes only while still sharing a `QueryClient`. @@ -104,5 +102,5 @@ A set of providers to set up TanStack Query. ## See -- https://tanstack.com/query/v5/docs/framework/angular/quick-start -- withDevtools + - https://tanstack.com/query/v5/docs/framework/angular/quick-start + - withDevtools diff --git a/docs/framework/angular/reference/functions/queryfeature.md b/docs/framework/angular/reference/functions/queryfeature.md index f749616ba4..46d7d72dd3 100644 --- a/docs/framework/angular/reference/functions/queryfeature.md +++ b/docs/framework/angular/reference/functions/queryfeature.md @@ -17,7 +17,7 @@ Helper function to create an object that represents a Query feature. ## Type Parameters -• **TFeatureKind** _extends_ `"Devtools"` \| `"PersistQueryClient"` +• **TFeatureKind** *extends* `"Devtools"` \| `"PersistQueryClient"` ## Parameters diff --git a/docs/framework/angular/reference/functions/queryoptions.md b/docs/framework/angular/reference/functions/queryoptions.md index d492b5a880..25847f526a 100644 --- a/docs/framework/angular/reference/functions/queryoptions.md +++ b/docs/framework/angular/reference/functions/queryoptions.md @@ -14,15 +14,15 @@ The `queryKey` will be tagged with the type from `queryFn`. **Example** ```ts -const { queryKey } = queryOptions({ - queryKey: ['key'], - queryFn: () => Promise.resolve(5), - // ^? Promise -}) - -const queryClient = new QueryClient() -const data = queryClient.getQueryData(queryKey) -// ^? number | undefined + const { queryKey } = queryOptions({ + queryKey: ['key'], + queryFn: () => Promise.resolve(5), + // ^? Promise + }) + + const queryClient = new QueryClient() + const data = queryClient.getQueryData(queryKey) + // ^? number | undefined ``` ## Param @@ -32,11 +32,7 @@ The query options to tag with the type from `queryFn`. ## Call Signature ```ts -function queryOptions( - options, -): Omit, 'queryFn'> & - object & - object +function queryOptions(options): Omit, "queryFn"> & object & object ``` Defined in: [query-options.ts:76](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L76) @@ -48,15 +44,15 @@ The `queryKey` will be tagged with the type from `queryFn`. **Example** ```ts -const { queryKey } = queryOptions({ - queryKey: ['key'], - queryFn: () => Promise.resolve(5), - // ^? Promise -}) - -const queryClient = new QueryClient() -const data = queryClient.getQueryData(queryKey) -// ^? number | undefined + const { queryKey } = queryOptions({ + queryKey: ['key'], + queryFn: () => Promise.resolve(5), + // ^? Promise + }) + + const queryClient = new QueryClient() + const data = queryClient.getQueryData(queryKey) + // ^? number | undefined ``` ### Type Parameters @@ -67,7 +63,7 @@ const data = queryClient.getQueryData(queryKey) • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] +• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[] ### Parameters @@ -92,14 +88,7 @@ The query options to tag with the type from `queryFn`. ## Call Signature ```ts -function queryOptions( - options, -): OmitKeyof< - CreateQueryOptions, - 'queryFn' -> & - object & - object +function queryOptions(options): OmitKeyof, "queryFn"> & object & object ``` Defined in: [query-options.ts:108](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L108) @@ -111,15 +100,15 @@ The `queryKey` will be tagged with the type from `queryFn`. **Example** ```ts -const { queryKey } = queryOptions({ - queryKey: ['key'], - queryFn: () => Promise.resolve(5), - // ^? Promise -}) - -const queryClient = new QueryClient() -const data = queryClient.getQueryData(queryKey) -// ^? number | undefined + const { queryKey } = queryOptions({ + queryKey: ['key'], + queryFn: () => Promise.resolve(5), + // ^? Promise + }) + + const queryClient = new QueryClient() + const data = queryClient.getQueryData(queryKey) + // ^? number | undefined ``` ### Type Parameters @@ -130,7 +119,7 @@ const data = queryClient.getQueryData(queryKey) • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] +• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[] ### Parameters @@ -155,9 +144,7 @@ The query options to tag with the type from `queryFn`. ## Call Signature ```ts -function queryOptions( - options, -): CreateQueryOptions & object & object +function queryOptions(options): CreateQueryOptions & object & object ``` Defined in: [query-options.ts:140](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L140) @@ -169,15 +156,15 @@ The `queryKey` will be tagged with the type from `queryFn`. **Example** ```ts -const { queryKey } = queryOptions({ - queryKey: ['key'], - queryFn: () => Promise.resolve(5), - // ^? Promise -}) - -const queryClient = new QueryClient() -const data = queryClient.getQueryData(queryKey) -// ^? number | undefined + const { queryKey } = queryOptions({ + queryKey: ['key'], + queryFn: () => Promise.resolve(5), + // ^? Promise + }) + + const queryClient = new QueryClient() + const data = queryClient.getQueryData(queryKey) + // ^? number | undefined ``` ### Type Parameters @@ -188,7 +175,7 @@ const data = queryClient.getQueryData(queryKey) • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ readonly `unknown`[] = readonly `unknown`[] +• **TQueryKey** *extends* readonly `unknown`[] = readonly `unknown`[] ### Parameters diff --git a/docs/framework/angular/reference/index.md b/docs/framework/angular/reference/index.md index d9d29d1e6a..447ece4c1c 100644 --- a/docs/framework/angular/reference/index.md +++ b/docs/framework/angular/reference/index.md @@ -1,6 +1,6 @@ --- -id: '@tanstack/angular-query-experimental' -title: '@tanstack/angular-query-experimental' +id: "@tanstack/angular-query-experimental" +title: "@tanstack/angular-query-experimental" --- @@ -36,7 +36,7 @@ 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) +- [DevtoolsFeature](../type-aliases/devtoolsfeature.md) - [PersistQueryClientFeature](../type-aliases/persistqueryclientfeature.md) - [QueriesOptions](../type-aliases/queriesoptions.md) - [QueriesResults](../type-aliases/queriesresults.md) @@ -55,7 +55,6 @@ title: '@tanstack/angular-query-experimental' - [injectIsRestoring](../functions/injectisrestoring.md) - [injectMutation](../functions/injectmutation.md) - [injectMutationState](../functions/injectmutationstate.md) -- [injectQueries](../functions/injectqueries.md) - [injectQuery](../functions/injectquery.md) - [~~injectQueryClient~~](../functions/injectqueryclient.md) - [mutationOptions](../functions/mutationoptions.md) diff --git a/docs/framework/angular/reference/interfaces/basemutationnarrowing.md b/docs/framework/angular/reference/interfaces/basemutationnarrowing.md index 157ed2d305..b55b7d08e5 100644 --- a/docs/framework/angular/reference/interfaces/basemutationnarrowing.md +++ b/docs/framework/angular/reference/interfaces/basemutationnarrowing.md @@ -7,7 +7,7 @@ title: BaseMutationNarrowing # Interface: BaseMutationNarrowing\ -Defined in: [types.ts:183](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L183) +Defined in: [types.ts:190](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L190) ## Type Parameters @@ -24,117 +24,37 @@ Defined in: [types.ts:183](https://github.com/TanStack/query/blob/main/packages/ ### isError ```ts -isError: SignalFunction< - (this) => this is CreateMutationResult< - TData, - TError, - TVariables, - TOnMutateResult, - Override< - MutationObserverErrorResult, - { - mutate: CreateMutateFunction - } - > & { - mutateAsync: CreateMutateAsyncFunction< - TData, - TError, - TVariables, - TOnMutateResult - > - } - > -> +isError: SignalFunction<(this) => this is CreateMutationResult, { mutate: CreateMutateFunction }> & { mutateAsync: CreateMutateAsyncFunction }>>; ``` -Defined in: [types.ts:206](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L206) +Defined in: [types.ts:213](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L213) ---- +*** ### isIdle ```ts -isIdle: SignalFunction< - (this) => this is CreateMutationResult< - TData, - TError, - TVariables, - TOnMutateResult, - Override< - MutationObserverIdleResult, - { - mutate: CreateMutateFunction - } - > & { - mutateAsync: CreateMutateAsyncFunction< - TData, - TError, - TVariables, - TOnMutateResult - > - } - > -> +isIdle: SignalFunction<(this) => this is CreateMutationResult, { mutate: CreateMutateFunction }> & { mutateAsync: CreateMutateAsyncFunction }>>; ``` -Defined in: [types.ts:240](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L240) +Defined in: [types.ts:247](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L247) ---- +*** ### isPending ```ts -isPending: SignalFunction< - (this) => this is CreateMutationResult< - TData, - TError, - TVariables, - TOnMutateResult, - Override< - MutationObserverLoadingResult, - { - mutate: CreateMutateFunction - } - > & { - mutateAsync: CreateMutateAsyncFunction< - TData, - TError, - TVariables, - TOnMutateResult - > - } - > -> +isPending: SignalFunction<(this) => this is CreateMutationResult, { mutate: CreateMutateFunction }> & { mutateAsync: CreateMutateAsyncFunction }>>; ``` -Defined in: [types.ts:223](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L223) +Defined in: [types.ts:230](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L230) ---- +*** ### isSuccess ```ts -isSuccess: SignalFunction< - (this) => this is CreateMutationResult< - TData, - TError, - TVariables, - TOnMutateResult, - Override< - MutationObserverSuccessResult, - { - mutate: CreateMutateFunction - } - > & { - mutateAsync: CreateMutateAsyncFunction< - TData, - TError, - TVariables, - TOnMutateResult - > - } - > -> +isSuccess: SignalFunction<(this) => this is CreateMutationResult, { mutate: CreateMutateFunction }> & { mutateAsync: CreateMutateAsyncFunction }>>; ``` -Defined in: [types.ts:189](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L189) +Defined in: [types.ts:196](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L196) diff --git a/docs/framework/angular/reference/interfaces/basequerynarrowing.md b/docs/framework/angular/reference/interfaces/basequerynarrowing.md index 3a8618c7ab..cee854982a 100644 --- a/docs/framework/angular/reference/interfaces/basequerynarrowing.md +++ b/docs/framework/angular/reference/interfaces/basequerynarrowing.md @@ -35,7 +35,7 @@ Defined in: [types.ts:65](https://github.com/TanStack/query/blob/main/packages/a `this is CreateBaseQueryResult>` ---- +*** ### isPending() @@ -55,7 +55,7 @@ Defined in: [types.ts:72](https://github.com/TanStack/query/blob/main/packages/a `this is CreateBaseQueryResult>` ---- +*** ### isSuccess() diff --git a/docs/framework/angular/reference/interfaces/createbasequeryoptions.md b/docs/framework/angular/reference/interfaces/createbasequeryoptions.md index e0d731d5b3..3e1ee35164 100644 --- a/docs/framework/angular/reference/interfaces/createbasequeryoptions.md +++ b/docs/framework/angular/reference/interfaces/createbasequeryoptions.md @@ -23,4 +23,4 @@ Defined in: [types.ts:21](https://github.com/TanStack/query/blob/main/packages/a • **TQueryData** = `TQueryFnData` -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** *extends* `QueryKey` = `QueryKey` diff --git a/docs/framework/angular/reference/interfaces/createinfinitequeryoptions.md b/docs/framework/angular/reference/interfaces/createinfinitequeryoptions.md index 53ad6617ca..e1e744ba4f 100644 --- a/docs/framework/angular/reference/interfaces/createinfinitequeryoptions.md +++ b/docs/framework/angular/reference/interfaces/createinfinitequeryoptions.md @@ -21,6 +21,6 @@ Defined in: [types.ts:81](https://github.com/TanStack/query/blob/main/packages/a • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** *extends* `QueryKey` = `QueryKey` • **TPageParam** = `unknown` diff --git a/docs/framework/angular/reference/interfaces/createqueryoptions.md b/docs/framework/angular/reference/interfaces/createqueryoptions.md index 61baca7951..f4242283e0 100644 --- a/docs/framework/angular/reference/interfaces/createqueryoptions.md +++ b/docs/framework/angular/reference/interfaces/createqueryoptions.md @@ -21,4 +21,4 @@ Defined in: [types.ts:35](https://github.com/TanStack/query/blob/main/packages/a • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** *extends* `QueryKey` = `QueryKey` diff --git a/docs/framework/angular/reference/interfaces/injectmutationoptions.md b/docs/framework/angular/reference/interfaces/injectmutationoptions.md index 0de78ed031..62ebe8fa65 100644 --- a/docs/framework/angular/reference/interfaces/injectmutationoptions.md +++ b/docs/framework/angular/reference/interfaces/injectmutationoptions.md @@ -7,7 +7,7 @@ title: InjectMutationOptions # Interface: InjectMutationOptions -Defined in: [inject-mutation.ts:27](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L27) +Defined in: [inject-mutation.ts:28](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L28) ## Properties @@ -17,7 +17,7 @@ Defined in: [inject-mutation.ts:27](https://github.com/TanStack/query/blob/main/ optional injector: Injector; ``` -Defined in: [inject-mutation.ts:33](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L33) +Defined in: [inject-mutation.ts:34](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-mutation.ts#L34) The `Injector` in which to create the mutation. diff --git a/docs/framework/angular/reference/interfaces/queryfeature.md b/docs/framework/angular/reference/interfaces/queryfeature.md index 70871d1f80..cfc23901dd 100644 --- a/docs/framework/angular/reference/interfaces/queryfeature.md +++ b/docs/framework/angular/reference/interfaces/queryfeature.md @@ -13,19 +13,19 @@ Helper type to represent a Query feature. ## Type Parameters -• **TFeatureKind** _extends_ `QueryFeatureKind` +• **TFeatureKind** *extends* `QueryFeatureKind` ## Properties ### ɵkind ```ts -ɵkind: TFeatureKind +ɵkind: TFeatureKind; ``` Defined in: [providers.ts:136](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L136) ---- +*** ### ɵproviders diff --git a/docs/framework/angular/reference/type-aliases/createbasemutationresult.md b/docs/framework/angular/reference/type-aliases/createbasemutationresult.md index 4c33f30311..869d37e2ef 100644 --- a/docs/framework/angular/reference/type-aliases/createbasemutationresult.md +++ b/docs/framework/angular/reference/type-aliases/createbasemutationresult.md @@ -8,29 +8,19 @@ title: CreateBaseMutationResult # Type Alias: CreateBaseMutationResult\ ```ts -type CreateBaseMutationResult = - Override< - MutationObserverResult, - { - mutate: CreateMutateFunction - } - > & - object +type CreateBaseMutationResult = Override, { + mutate: CreateMutateFunction; + }> & object; ``` -Defined in: [types.ts:158](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L158) +Defined in: [types.ts:160](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L160) ## Type declaration ### mutateAsync ```ts -mutateAsync: CreateMutateAsyncFunction< - TData, - TError, - TVariables, - TOnMutateResult -> +mutateAsync: CreateMutateAsyncFunction; ``` ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/createbasequeryresult.md b/docs/framework/angular/reference/type-aliases/createbasequeryresult.md index 1dd27ac995..02406bfa51 100644 --- a/docs/framework/angular/reference/type-aliases/createbasequeryresult.md +++ b/docs/framework/angular/reference/type-aliases/createbasequeryresult.md @@ -8,11 +8,7 @@ title: CreateBaseQueryResult # Type Alias: CreateBaseQueryResult\ ```ts -type CreateBaseQueryResult = BaseQueryNarrowing< - TData, - TError -> & - MapToSignals> +type CreateBaseQueryResult = BaseQueryNarrowing & MapToSignals>; ``` Defined in: [types.ts:98](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L98) diff --git a/docs/framework/angular/reference/type-aliases/createinfinitequeryresult.md b/docs/framework/angular/reference/type-aliases/createinfinitequeryresult.md index a2db0e64fd..6176823282 100644 --- a/docs/framework/angular/reference/type-aliases/createinfinitequeryresult.md +++ b/docs/framework/angular/reference/type-aliases/createinfinitequeryresult.md @@ -8,11 +8,7 @@ title: CreateInfiniteQueryResult # Type Alias: CreateInfiniteQueryResult\ ```ts -type CreateInfiniteQueryResult = BaseQueryNarrowing< - TData, - TError -> & - MapToSignals> +type CreateInfiniteQueryResult = BaseQueryNarrowing & MapToSignals>; ``` 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/createmutateasyncfunction.md b/docs/framework/angular/reference/type-aliases/createmutateasyncfunction.md index d99ecc82d3..043cc82e2f 100644 --- a/docs/framework/angular/reference/type-aliases/createmutateasyncfunction.md +++ b/docs/framework/angular/reference/type-aliases/createmutateasyncfunction.md @@ -8,11 +8,10 @@ title: CreateMutateAsyncFunction # Type Alias: CreateMutateAsyncFunction\ ```ts -type CreateMutateAsyncFunction = - MutateFunction +type CreateMutateAsyncFunction = MutateFunction; ``` -Defined in: [types.ts:151](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L151) +Defined in: [types.ts:153](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L153) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/createmutatefunction.md b/docs/framework/angular/reference/type-aliases/createmutatefunction.md index 424686ed75..fe0fa55dc8 100644 --- a/docs/framework/angular/reference/type-aliases/createmutatefunction.md +++ b/docs/framework/angular/reference/type-aliases/createmutatefunction.md @@ -8,9 +8,7 @@ title: CreateMutateFunction # Type Alias: CreateMutateFunction()\ ```ts -type CreateMutateFunction = ( - ...args -) => void +type CreateMutateFunction = (...args) => void; ``` Defined in: [types.ts:142](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L142) diff --git a/docs/framework/angular/reference/type-aliases/createmutationresult.md b/docs/framework/angular/reference/type-aliases/createmutationresult.md index 0b2ceb3a70..86c631772b 100644 --- a/docs/framework/angular/reference/type-aliases/createmutationresult.md +++ b/docs/framework/angular/reference/type-aliases/createmutationresult.md @@ -8,12 +8,10 @@ title: CreateMutationResult # Type Alias: CreateMutationResult\ ```ts -type CreateMutationResult = - BaseMutationNarrowing & - MapToSignals> +type CreateMutationResult = BaseMutationNarrowing & MapToSignals>; ``` -Defined in: [types.ts:259](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L259) +Defined in: [types.ts:266](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L266) ## Type Parameters diff --git a/docs/framework/angular/reference/type-aliases/createqueryresult.md b/docs/framework/angular/reference/type-aliases/createqueryresult.md index 16c95c6798..11c07e5aba 100644 --- a/docs/framework/angular/reference/type-aliases/createqueryresult.md +++ b/docs/framework/angular/reference/type-aliases/createqueryresult.md @@ -8,7 +8,7 @@ title: CreateQueryResult # Type Alias: CreateQueryResult\ ```ts -type CreateQueryResult = CreateBaseQueryResult +type CreateQueryResult = CreateBaseQueryResult; ``` Defined in: [types.ts:105](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L105) diff --git a/docs/framework/angular/reference/type-aliases/definedcreateinfinitequeryresult.md b/docs/framework/angular/reference/type-aliases/definedcreateinfinitequeryresult.md index 3585ab5bf1..297c65bca9 100644 --- a/docs/framework/angular/reference/type-aliases/definedcreateinfinitequeryresult.md +++ b/docs/framework/angular/reference/type-aliases/definedcreateinfinitequeryresult.md @@ -8,11 +8,7 @@ title: DefinedCreateInfiniteQueryResult # Type Alias: DefinedCreateInfiniteQueryResult\ ```ts -type DefinedCreateInfiniteQueryResult< - TData, - TError, - TDefinedInfiniteQueryObserver, -> = MapToSignals +type DefinedCreateInfiniteQueryResult = MapToSignals; ``` Defined in: [types.ts:123](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L123) diff --git a/docs/framework/angular/reference/type-aliases/definedcreatequeryresult.md b/docs/framework/angular/reference/type-aliases/definedcreatequeryresult.md index b3588c97c7..b764ec669b 100644 --- a/docs/framework/angular/reference/type-aliases/definedcreatequeryresult.md +++ b/docs/framework/angular/reference/type-aliases/definedcreatequeryresult.md @@ -8,11 +8,7 @@ title: DefinedCreateQueryResult # Type Alias: DefinedCreateQueryResult\ ```ts -type DefinedCreateQueryResult = BaseQueryNarrowing< - TData, - TError -> & - MapToSignals> +type DefinedCreateQueryResult = BaseQueryNarrowing & MapToSignals>; ``` Defined in: [types.ts:110](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/types.ts#L110) diff --git a/docs/framework/angular/reference/type-aliases/definedinitialdatainfiniteoptions.md b/docs/framework/angular/reference/type-aliases/definedinitialdatainfiniteoptions.md index 16025e3fc7..dabe372f90 100644 --- a/docs/framework/angular/reference/type-aliases/definedinitialdatainfiniteoptions.md +++ b/docs/framework/angular/reference/type-aliases/definedinitialdatainfiniteoptions.md @@ -8,20 +8,7 @@ title: DefinedInitialDataInfiniteOptions # Type Alias: DefinedInitialDataInfiniteOptions\ ```ts -type DefinedInitialDataInfiniteOptions< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam, -> = CreateInfiniteQueryOptions< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam -> & - object +type DefinedInitialDataInfiniteOptions = CreateInfiniteQueryOptions & object; ``` Defined in: [infinite-query-options.ts:62](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L62) @@ -31,7 +18,7 @@ Defined in: [infinite-query-options.ts:62](https://github.com/TanStack/query/blo ### initialData ```ts -initialData: +initialData: | NonUndefinedGuard> | () => NonUndefinedGuard> | undefined; @@ -45,6 +32,6 @@ initialData: • **TData** = `InfiniteData`\<`TQueryFnData`\> -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** *extends* `QueryKey` = `QueryKey` • **TPageParam** = `unknown` diff --git a/docs/framework/angular/reference/type-aliases/definedinitialdataoptions.md b/docs/framework/angular/reference/type-aliases/definedinitialdataoptions.md index a54c79c787..d0613848bc 100644 --- a/docs/framework/angular/reference/type-aliases/definedinitialdataoptions.md +++ b/docs/framework/angular/reference/type-aliases/definedinitialdataoptions.md @@ -8,11 +8,7 @@ title: DefinedInitialDataOptions # Type Alias: DefinedInitialDataOptions\ ```ts -type DefinedInitialDataOptions = Omit< - CreateQueryOptions, - 'queryFn' -> & - object +type DefinedInitialDataOptions = Omit, "queryFn"> & object; ``` Defined in: [query-options.ts:40](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L40) @@ -22,7 +18,7 @@ Defined in: [query-options.ts:40](https://github.com/TanStack/query/blob/main/pa ### initialData ```ts -initialData: +initialData: | NonUndefinedGuard | () => NonUndefinedGuard; ``` @@ -41,4 +37,4 @@ optional queryFn: QueryFunction; • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** *extends* `QueryKey` = `QueryKey` diff --git a/docs/framework/angular/reference/type-aliases/developertoolsfeature.md b/docs/framework/angular/reference/type-aliases/devtoolsfeature.md similarity index 73% rename from docs/framework/angular/reference/type-aliases/developertoolsfeature.md rename to docs/framework/angular/reference/type-aliases/devtoolsfeature.md index b1278a3d2e..668aab3b72 100644 --- a/docs/framework/angular/reference/type-aliases/developertoolsfeature.md +++ b/docs/framework/angular/reference/type-aliases/devtoolsfeature.md @@ -1,14 +1,14 @@ --- -id: DeveloperToolsFeature -title: DeveloperToolsFeature +id: DevtoolsFeature +title: DevtoolsFeature --- -# Type Alias: DeveloperToolsFeature +# Type Alias: DevtoolsFeature ```ts -type DeveloperToolsFeature = QueryFeature<'Devtools'> +type DevtoolsFeature = QueryFeature<"Devtools">; ``` 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/persistqueryclientfeature.md b/docs/framework/angular/reference/type-aliases/persistqueryclientfeature.md index 2e923a3c6a..c4bd1e64c4 100644 --- a/docs/framework/angular/reference/type-aliases/persistqueryclientfeature.md +++ b/docs/framework/angular/reference/type-aliases/persistqueryclientfeature.md @@ -8,7 +8,7 @@ title: PersistQueryClientFeature # Type Alias: PersistQueryClientFeature ```ts -type PersistQueryClientFeature = QueryFeature<'PersistQueryClient'> +type PersistQueryClientFeature = QueryFeature<"PersistQueryClient">; ``` Defined in: [providers.ts:164](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L164) diff --git a/docs/framework/angular/reference/type-aliases/queriesoptions.md b/docs/framework/angular/reference/type-aliases/queriesoptions.md index 88e9502ce3..3d0a571ef0 100644 --- a/docs/framework/angular/reference/type-aliases/queriesoptions.md +++ b/docs/framework/angular/reference/type-aliases/queriesoptions.md @@ -5,46 +5,20 @@ title: QueriesOptions -# Type Alias: 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< - infer TQueryFnData, - infer TError, - infer TData, - infer TQueryKey - >[] - ? QueryObserverOptionsForCreateQueries< - TQueryFnData, - TError, - TData, - TQueryKey - >[] - : QueryObserverOptionsForCreateQueries[] +type QueriesOptions = TDepth["length"] extends MAXIMUM_DEPTH ? QueryObserverOptionsForCreateQueries[] : T extends [] ? [] : T extends [infer Head] ? [...TResults, GetCreateQueryOptionsForCreateQueries] : T extends [infer Head, ...(infer Tails)] ? QueriesOptions<[...Tails], [...TResults, GetCreateQueryOptionsForCreateQueries], [...TDepth, 1]> : ReadonlyArray extends T ? T : T extends QueryObserverOptionsForCreateQueries[] ? QueryObserverOptionsForCreateQueries[] : QueryObserverOptionsForCreateQueries[]; ``` -Defined in: [inject-queries.ts:120](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L120) +Defined in: [inject-queries.ts:144](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L144) QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param ## Type Parameters -• **T** _extends_ `any`[] +• **T** *extends* `any`[] -• **TResult** _extends_ `any`[] = \[\] +• **TResults** *extends* `any`[] = \[\] -• **TDepth** _extends_ `ReadonlyArray`\<`number`\> = \[\] +• **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 b977f67923..b691044942 100644 --- a/docs/framework/angular/reference/type-aliases/queriesresults.md +++ b/docs/framework/angular/reference/type-aliases/queriesresults.md @@ -5,42 +5,20 @@ title: QueriesResults -# Type Alias: 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< - infer TQueryFnData, - infer TError, - infer TData, - any - >[] - ? QueryObserverResult< - unknown extends TData ? TQueryFnData : TData, - unknown extends TError ? DefaultError : TError - >[] - : QueryObserverResult[] +type QueriesResults = TDepth["length"] extends MAXIMUM_DEPTH ? CreateQueryResult[] : T extends [] ? [] : T extends [infer Head] ? [...TResults, GetCreateQueryResult] : T extends [infer Head, ...(infer Tails)] ? QueriesResults<[...Tails], [...TResults, GetCreateQueryResult], [...TDepth, 1]> : { [K in keyof T]: GetCreateQueryResult }; ``` -Defined in: [inject-queries.ts:162](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L162) +Defined in: [inject-queries.ts:186](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-queries.ts#L186) QueriesResults reducer recursively maps type param to results ## Type Parameters -• **T** _extends_ `any`[] +• **T** *extends* `any`[] -• **TResult** _extends_ `any`[] = \[\] +• **TResults** *extends* `any`[] = \[\] -• **TDepth** _extends_ `ReadonlyArray`\<`number`\> = \[\] +• **TDepth** *extends* `ReadonlyArray`\<`number`\> = \[\] diff --git a/docs/framework/angular/reference/type-aliases/queryfeatures.md b/docs/framework/angular/reference/type-aliases/queryfeatures.md index 8167e22cf3..8344709fa7 100644 --- a/docs/framework/angular/reference/type-aliases/queryfeatures.md +++ b/docs/framework/angular/reference/type-aliases/queryfeatures.md @@ -8,7 +8,9 @@ title: QueryFeatures # Type Alias: QueryFeatures ```ts -type QueryFeatures = DeveloperToolsFeature | PersistQueryClientFeature +type QueryFeatures = + | DevtoolsFeature + | PersistQueryClientFeature; ``` Defined in: [providers.ts:173](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/providers.ts#L173) diff --git a/docs/framework/angular/reference/type-aliases/undefinedinitialdatainfiniteoptions.md b/docs/framework/angular/reference/type-aliases/undefinedinitialdatainfiniteoptions.md index 0d33355981..9061a58458 100644 --- a/docs/framework/angular/reference/type-aliases/undefinedinitialdatainfiniteoptions.md +++ b/docs/framework/angular/reference/type-aliases/undefinedinitialdatainfiniteoptions.md @@ -8,20 +8,7 @@ title: UndefinedInitialDataInfiniteOptions # Type Alias: UndefinedInitialDataInfiniteOptions\ ```ts -type UndefinedInitialDataInfiniteOptions< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam, -> = CreateInfiniteQueryOptions< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam -> & - object +type UndefinedInitialDataInfiniteOptions = CreateInfiniteQueryOptions & object; ``` Defined in: [infinite-query-options.ts:13](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L13) @@ -31,7 +18,7 @@ Defined in: [infinite-query-options.ts:13](https://github.com/TanStack/query/blo ### initialData? ```ts -optional initialData: +optional initialData: | NonUndefinedGuard> | InitialDataFunction>>; ``` @@ -44,6 +31,6 @@ optional initialData: • **TData** = `InfiniteData`\<`TQueryFnData`\> -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** *extends* `QueryKey` = `QueryKey` • **TPageParam** = `unknown` diff --git a/docs/framework/angular/reference/type-aliases/undefinedinitialdataoptions.md b/docs/framework/angular/reference/type-aliases/undefinedinitialdataoptions.md index 3f5a06db66..12037f13e7 100644 --- a/docs/framework/angular/reference/type-aliases/undefinedinitialdataoptions.md +++ b/docs/framework/angular/reference/type-aliases/undefinedinitialdataoptions.md @@ -8,8 +8,7 @@ title: UndefinedInitialDataOptions # Type Alias: UndefinedInitialDataOptions\ ```ts -type UndefinedInitialDataOptions = - CreateQueryOptions & object +type UndefinedInitialDataOptions = CreateQueryOptions & object; ``` Defined in: [query-options.ts:13](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L13) @@ -19,7 +18,7 @@ Defined in: [query-options.ts:13](https://github.com/TanStack/query/blob/main/pa ### initialData? ```ts -optional initialData: +optional initialData: | InitialDataFunction> | NonUndefinedGuard; ``` @@ -32,4 +31,4 @@ optional initialData: • **TData** = `TQueryFnData` -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** *extends* `QueryKey` = `QueryKey` diff --git a/docs/framework/angular/reference/type-aliases/unusedskiptokeninfiniteoptions.md b/docs/framework/angular/reference/type-aliases/unusedskiptokeninfiniteoptions.md index 9634febe87..eebf0bb773 100644 --- a/docs/framework/angular/reference/type-aliases/unusedskiptokeninfiniteoptions.md +++ b/docs/framework/angular/reference/type-aliases/unusedskiptokeninfiniteoptions.md @@ -8,23 +8,7 @@ title: UnusedSkipTokenInfiniteOptions # Type Alias: UnusedSkipTokenInfiniteOptions\ ```ts -type UnusedSkipTokenInfiniteOptions< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam, -> = OmitKeyof< - CreateInfiniteQueryOptions< - TQueryFnData, - TError, - TData, - TQueryKey, - TPageParam - >, - 'queryFn' -> & - object +type UnusedSkipTokenInfiniteOptions = OmitKeyof, "queryFn"> & object; ``` Defined in: [infinite-query-options.ts:34](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/infinite-query-options.ts#L34) @@ -45,6 +29,6 @@ optional queryFn: Exclude -• **TQueryKey** _extends_ `QueryKey` = `QueryKey` +• **TQueryKey** *extends* `QueryKey` = `QueryKey` • **TPageParam** = `unknown` diff --git a/docs/framework/angular/reference/type-aliases/unusedskiptokenoptions.md b/docs/framework/angular/reference/type-aliases/unusedskiptokenoptions.md index d115842200..ec956c1148 100644 --- a/docs/framework/angular/reference/type-aliases/unusedskiptokenoptions.md +++ b/docs/framework/angular/reference/type-aliases/unusedskiptokenoptions.md @@ -8,11 +8,7 @@ title: UnusedSkipTokenOptions # Type Alias: UnusedSkipTokenOptions\ ```ts -type UnusedSkipTokenOptions = OmitKeyof< - CreateQueryOptions, - 'queryFn' -> & - object +type UnusedSkipTokenOptions = OmitKeyof, "queryFn"> & object; ``` Defined in: [query-options.ts:25](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/query-options.ts#L25) @@ -33,4 +29,4 @@ optional queryFn: Exclude) => DevtoolsOptions export type WithDevtools = ( withDevtoolsFn?: WithDevtoolsFn, options?: WithDevtoolsOptions, -) => DeveloperToolsFeature +) => DevtoolsFeature diff --git a/packages/angular-query-experimental/src/index.ts b/packages/angular-query-experimental/src/index.ts index bad24075cc..fc033224e5 100644 --- a/packages/angular-query-experimental/src/index.ts +++ b/packages/angular-query-experimental/src/index.ts @@ -47,7 +47,7 @@ export { injectQuery } from './inject-query' export { injectQueryClient } from './inject-query-client' export type { - DeveloperToolsFeature, + DevtoolsFeature, PersistQueryClientFeature, QueryFeature, QueryFeatures, diff --git a/packages/angular-query-experimental/src/providers.ts b/packages/angular-query-experimental/src/providers.ts index 3473c2affb..076d76d0c3 100644 --- a/packages/angular-query-experimental/src/providers.ts +++ b/packages/angular-query-experimental/src/providers.ts @@ -155,7 +155,7 @@ export function queryFeature( * The type is used to describe the return value of the `withDevtools` function. * @see {@link withDevtools} */ -export type DeveloperToolsFeature = QueryFeature<'Devtools'> +export type DevtoolsFeature = QueryFeature<'Devtools'> /** * A type alias that represents a feature which enables persistence. @@ -170,4 +170,4 @@ export type PersistQueryClientFeature = QueryFeature<'PersistQueryClient'> * documentation on how to use those functions. * @see {@link provideTanStackQuery} */ -export type QueryFeatures = DeveloperToolsFeature | PersistQueryClientFeature +export type QueryFeatures = DevtoolsFeature | PersistQueryClientFeature