Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

provideTanStackQuery.md

69 lines1.8 KB

1---
2id: provideTanStackQuery
3title: provideTanStackQuery
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8```ts
9function provideTanStackQuery(queryClientFactory: () => QueryClient, ...features: readonly QueryFeature[]): EnvironmentProviders;
10```
11​
12Defined in: [packages/angular-query/src/providers.ts:101](https://github.com/TanStack/query/blob/main/packages/angular-query/src/providers.ts#L101)
13​
14Provides a `QueryClient` and optional TanStack Query features.
15The factory runs once per injector in Angular's injection context, so it can
16call `inject()` and each SSR request can receive an independent cache.
17​
18## Parameters
19​
20### queryClientFactory
21​
22() => [`QueryClient`](../classes/QueryClient.md)
23​
24Creates or resolves a `QueryClient` in the injection context.
25​
26### features
27​
28...readonly [`QueryFeature`](../interfaces/QueryFeature.md)[]
29​
30Optional features to configure additional Query functionality.
31​
32## Returns
33​
34`EnvironmentProviders`
35​
36A single EnvironmentProviders value (do not spread into `providers`).
37​
38## See
39​
40 - https://tanstack.com/query/v5/docs/framework/angular/quick-start
41 - https://tanstack.com/query/v5/docs/framework/angular/devtools
42 - https://tanstack.com/query/latest/docs/framework/angular/guides/ssr
43​
44## Example
45​
46```ts
47import {
48 provideTanStackQuery,
49 QueryClient,
50} from '@tanstack/angular-query'
51​
52bootstrapApplication(AppComponent, {
53 providers: [provideTanStackQuery(() => new QueryClient())],
54})
55```
56​
57You can also enable optional developer tools by adding `withDevtools`. By
58default the tools will then be loaded when your app is in development mode.
59​
60```ts
61import { provideTanStackQuery, QueryClient } from '@tanstack/angular-query'
62import { withDevtools } from '@tanstack/angular-query-devtools'
63​
64bootstrapApplication(AppComponent, {
65 providers: [
66 provideTanStackQuery(() => new QueryClient(), withDevtools()),
67 ],
68})
69```