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

injectQueryClient.md

38 lines921 Bytes

1---
2id: injectQueryClient
3title: injectQueryClient
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8```ts
9function injectQueryClient(injectOptions?: InjectOptions & object): QueryClient;
10```
11​
12Defined 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)
13​
14Injects a `QueryClient` instance and allows passing a custom injector.
15​
16## Parameters
17​
18### injectOptions?
19​
20`InjectOptions` & `object` = `{}`
21​
22Type of the options argument to inject and optionally a custom injector.
23​
24## Returns
25​
26[`QueryClient`](../classes/QueryClient.md)
27​
28The `QueryClient` instance.
29​
30## Deprecated
31​
32Use `inject(QueryClient)` instead.
33If you need to get a `QueryClient` from a custom injector, use `injector.get(QueryClient)`.
34​
35**Example**
36```ts
37const queryClient = injectQueryClient();
38```