* docs(query-core): add JSDoc across the package and expose it in generated reference docs * docs(config.json): add sidebar entries for newly generated query-core reference docs * docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc * docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference * docs(query-core): regenerate reference docs after merging main * docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type * fix(query-devtools): drop unnecessary 'query-core' project reference * docs(query-core): document missing default values and normalize 'Defaults to' spacing * docs(query-core): fix 'environmentManager' JSDoc example
2.5 KiB
| id | title |
|---|---|
| provideTanStackQuery | provideTanStackQuery |
function provideTanStackQuery(queryClient, ...features): Provider[];
Defined in: packages/angular-query-experimental/src/providers.ts:102
Sets up providers necessary to enable TanStack Query functionality for Angular applications. Allows
configuring a QueryClient and optional features such as developer tools.
Parameters
queryClient
A QueryClient instance, or an InjectionToken which provides a QueryClient.
QueryClient | InjectionToken<QueryClient>
features
...QueryFeatures[]
Optional features to configure additional Query functionality.
Returns
Provider[]
A set of providers to set up TanStack Query.
See
Examples
import { provideTanStackQuery, QueryClient } from '@tanstack/angular-query-experimental'
bootstrapApplication(AppComponent, {
providers: [provideTanStackQuery(new QueryClient())],
})
The same, in an NgModule-based application:
import { provideTanStackQuery, QueryClient } from '@tanstack/angular-query-experimental'
@NgModule({
declarations: [AppComponent],
imports: [BrowserModule],
providers: [provideTanStackQuery(new QueryClient())],
bootstrap: [AppComponent],
})
export class AppModule {}
Enabling optional developer tools by adding withDevtools — by default, the tools are then loaded when
your app is in development mode:
import {
provideTanStackQuery,
withDevtools,
QueryClient,
} from '@tanstack/angular-query-experimental'
bootstrapApplication(AppComponent, {
providers: [provideTanStackQuery(new QueryClient(), withDevtools())],
})
Using an InjectionToken for the QueryClient — an advanced optimization that lets TanStack Query be
absent from the main application bundle, useful for including it on lazy-loaded routes only while still
sharing a QueryClient. This is a small optimization; for most applications it's preferable to provide
the QueryClient in the main application config, as in the examples above:
export const MY_QUERY_CLIENT = new InjectionToken('', {
factory: () => new QueryClient(),
})
// In a lazy loaded route or lazy loaded component's providers array:
providers: [provideTanStackQuery(MY_QUERY_CLIENT)]