0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/angular/reference/functions/provideQueryClient.md
Wonsuk Choi e57f8163b1
docs(query-core): add JSDoc across the package and expose it in generated reference docs (#11438)
* 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
2026-09-07 18:22:38 +02:00

1.2 KiB

id title
provideQueryClient provideQueryClient
function provideQueryClient(queryClient): Provider;

Defined in: packages/angular-query-experimental/src/providers.ts:22

Usually provideTanStackQuery is used once to set up TanStack Query and the QueryClient for the entire application — it calls provideQueryClient internally. Use provideQueryClient directly to provide a different QueryClient instance for part of the application, or for unit testing.

Parameters

queryClient

A QueryClient instance, or an InjectionToken which provides a QueryClient.

QueryClient | InjectionToken<QueryClient>

Returns

Provider

A provider object that can be used to provide the QueryClient instance.

Example

Providing a test-only QueryClient in a component test, without wiring up provideTanStackQuery's other defaults:

TestBed.configureTestingModule({
  providers: [provideQueryClient(new QueryClient())],
})