Open History to see the last commit
1import { InfiniteQueryObserver } from '@tanstack/query-core'
2import { createBaseQuery } from './create-base-query'
3import { assertInjector } from './util/assert-injector/assert-injector'
4import type { Injector } from '@angular/core'
5import type {
6 DefaultError,
7 InfiniteData,
8 QueryKey,
9 QueryObserver,
10} from '@tanstack/query-core'
11import type {
12 CreateInfiniteQueryOptions,
13 CreateInfiniteQueryResult,
14 DefinedCreateInfiniteQueryResult,
15} from './types'
16import type {
17 DefinedInitialDataInfiniteOptions,
18 UndefinedInitialDataInfiniteOptions,
19} from './infinite-query-options'
20β
21/**
22 * Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
23 * Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
24 * @param optionsFn - A function that returns infinite query options.
25 * @param injector - The Angular injector to use.
26 * @returns The infinite query result.
27 * @public
28 */
29export function injectInfiniteQuery<
30 TQueryFnData,
31 TError = DefaultError,
32 TData = InfiniteData<TQueryFnData>,
33 TQueryKey extends QueryKey = QueryKey,
34 TPageParam = unknown,
35>(
36 optionsFn: () => DefinedInitialDataInfiniteOptions<
37 TQueryFnData,
38 TError,
39 TData,
40 TQueryKey,
41 TPageParam
42 >,
43 injector?: Injector,
44): DefinedCreateInfiniteQueryResult<TData, TError>
45β
46/**
47 * Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
48 * Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
49 * @param optionsFn - A function that returns infinite query options.
50 * @param injector - The Angular injector to use.
51 * @returns The infinite query result.
52 * @public
53 */
54export function injectInfiniteQuery<
55 TQueryFnData,
56 TError = DefaultError,
57 TData = InfiniteData<TQueryFnData>,
58 TQueryKey extends QueryKey = QueryKey,
59 TPageParam = unknown,
60>(
61 optionsFn: () => UndefinedInitialDataInfiniteOptions<
62 TQueryFnData,
63 TError,
64 TData,
65 TQueryKey,
66 TPageParam
67 >,
68 injector?: Injector,
69): CreateInfiniteQueryResult<TData, TError>
70β
71/**
72 * Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
73 * Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
74 * @param optionsFn - A function that returns infinite query options.
75 * @param injector - The Angular injector to use.
76 * @returns The infinite query result.
77 * @public
78 */
79export function injectInfiniteQuery<
80 TQueryFnData,
81 TError = DefaultError,
82 TData = InfiniteData<TQueryFnData>,
83 TQueryKey extends QueryKey = QueryKey,
84 TPageParam = unknown,
85>(
86 optionsFn: () => CreateInfiniteQueryOptions<
87 TQueryFnData,
88 TError,
89 TData,
90 TQueryFnData,
91 TQueryKey,
92 TPageParam
93 >,
94 injector?: Injector,
95): CreateInfiniteQueryResult<TData, TError>
96β
97/**
98 * Injects an infinite query: a declarative dependency on an asynchronous source of data that is tied to a unique key.
99 * Infinite queries can additively "load more" data onto an existing set of data or "infinite scroll"
100 * @param optionsFn - A function that returns infinite query options.
101 * @param injector - The Angular injector to use.
102 * @returns The infinite query result.
103 * @public
104 */
105export function injectInfiniteQuery(
106 optionsFn: () => CreateInfiniteQueryOptions,
107 injector?: Injector,
108) {
109 return assertInjector(injectInfiniteQuery, injector, () =>
110 createBaseQuery(optionsFn, InfiniteQueryObserver as typeof QueryObserver),
111 )
112}