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

injectQueryClient.md

36 lines848 Bytes

1---
2id: injectQueryClient
3title: injectQueryClient
4---
5​
6```ts
7function injectQueryClient(injectOptions?: InjectOptions & object): QueryClient;
8```
9​
10Defined in: [packages/angular-query-experimental/src/inject-query-client.ts:18](https://github.com/TanStack/query/blob/main/packages/angular-query-experimental/src/inject-query-client.ts#L18)
11​
12Injects a `QueryClient` instance and allows passing a custom injector.
13​
14## Parameters
15​
16### injectOptions?
17​
18`InjectOptions` & `object` = `{}`
19​
20Type of the options argument to inject and optionally a custom injector.
21​
22## Returns
23​
24[`QueryClient`](../classes/QueryClient.md)
25​
26The `QueryClient` instance.
27​
28## Deprecated
29​
30Use `inject(QueryClient)` instead.
31If you need to get a `QueryClient` from a custom injector, use `injector.get(QueryClient)`.
32​
33**Example**
34```ts
35const queryClient = injectQueryClient();
36```