Skip to content

Commit 5c61412

Browse files
TkDodoTkDodo
committed
manual mode
1 parent 4947e2b commit 5c61412

21 files changed

+124
-124
lines changed

‎packages/angular-query-experimental/src/__tests__/infinite-query-options.test-d.ts‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ describe('infiniteQueryOptions', () => {
3939
queryKey: ['key'],
4040
queryFn: () => Promise.resolve('string'),
4141
initialPageParam: 1,
42-
mode: 'imperative',
42+
mode: 'manual',
4343
})
4444

4545
const { data, fetchNextPage } = injectInfiniteQuery(() => options)
@@ -50,27 +50,27 @@ describe('infiniteQueryOptions', () => {
5050
>()
5151
fetchNextPage({ pageParam: 2 })
5252

53-
// @ts-expect-error pageParam is required in imperative mode
53+
// @ts-expect-error pageParam is required in manual mode
5454
fetchNextPage()
5555
})
5656

57-
it('should preserve imperative fetch method types', () => {
57+
it('should preserve manual fetch method types', () => {
5858
const options = infiniteQueryOptions({
5959
queryKey: ['key'],
6060
queryFn: ({ pageParam }) => {
6161
expectTypeOf(pageParam).toEqualTypeOf<number>()
6262
return pageParam * 5
6363
},
6464
initialPageParam: 1,
65-
mode: 'imperative',
65+
mode: 'manual',
6666
})
6767

6868
const { fetchNextPage, fetchPreviousPage } = injectInfiniteQuery(() => options)
6969

7070
fetchNextPage({ pageParam: 2 })
7171
fetchPreviousPage({ pageParam: 0 })
7272

73-
// @ts-expect-error pageParam is required in imperative mode
73+
// @ts-expect-error pageParam is required in manual mode
7474
fetchNextPage()
7575
})
7676

@@ -79,7 +79,7 @@ describe('infiniteQueryOptions', () => {
7979
queryKey: ['key'],
8080
queryFn: () => Promise.resolve('string'),
8181
initialPageParam: 1,
82-
mode: 'imperative',
82+
mode: 'manual',
8383
})
8484

8585
const data = await new QueryClient().fetchInfiniteQuery(options)
@@ -179,29 +179,29 @@ describe('infiniteQueryOptions', () => {
179179
)
180180
})
181181

182-
it('should reject missing mode / getNextPageParam and reject getters in imperative mode', () => {
183-
// @ts-expect-error getNextPageParam is required unless mode is imperative
182+
it('should reject missing mode / getNextPageParam and reject getters in manual mode', () => {
183+
// @ts-expect-error getNextPageParam is required unless mode is manual
184184
infiniteQueryOptions({
185185
queryKey: ['key'],
186186
queryFn: () => Promise.resolve('string'),
187187
initialPageParam: 1,
188188
})
189189

190-
// @ts-expect-error getNextPageParam is not allowed in imperative mode
190+
// @ts-expect-error getNextPageParam is not allowed in manual mode
191191
infiniteQueryOptions({
192192
queryKey: ['key'],
193193
queryFn: () => Promise.resolve('string'),
194194
initialPageParam: 1,
195-
mode: 'imperative',
195+
mode: 'manual',
196196
getNextPageParam: () => 1,
197197
})
198198

199-
// @ts-expect-error getPreviousPageParam is not allowed in imperative mode
199+
// @ts-expect-error getPreviousPageParam is not allowed in manual mode
200200
infiniteQueryOptions({
201201
queryKey: ['key'],
202202
queryFn: () => Promise.resolve('string'),
203203
initialPageParam: 1,
204-
mode: 'imperative',
204+
mode: 'manual',
205205
getPreviousPageParam: () => 0,
206206
})
207207
})

‎packages/angular-query-experimental/src/__tests__/inject-infinite-query.test-d.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,20 +40,20 @@ describe('injectInfiniteQuery', () => {
4040
}
4141
})
4242

43-
test('should require pageParam on imperative fetch methods', () => {
43+
test('should require pageParam on manual fetch methods', () => {
4444
const query = TestBed.runInInjectionContext(() => {
4545
return injectInfiniteQuery(() => ({
4646
queryKey: ['infiniteQuery'],
4747
queryFn: ({ pageParam }) => 'data on page ' + pageParam,
4848
initialPageParam: 0,
49-
mode: 'imperative',
49+
mode: 'manual',
5050
}))
5151
})
5252

5353
query.fetchNextPage({ pageParam: 1 })
5454
query.fetchPreviousPage({ pageParam: 0 })
5555

56-
// @ts-expect-error pageParam is required in imperative mode
56+
// @ts-expect-error pageParam is required in manual mode
5757
query.fetchNextPage()
5858
})
5959
})

‎packages/angular-query-experimental/src/infinite-query-options.ts‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ import type {
1111
} from '@tanstack/query-core'
1212
import type {
1313
CreateDeclarativeInfiniteQueryOptions,
14-
CreateImperativeInfiniteQueryOptions,
14+
CreateManualInfiniteQueryOptions,
1515
CreateInfiniteQueryOptions,
1616
} from './types'
1717

@@ -70,13 +70,13 @@ export type DeclarativeUndefinedInitialDataInfiniteOptions<
7070
> &
7171
OptionalInitialData<TQueryFnData, TPageParam>
7272

73-
export type ImperativeUndefinedInitialDataInfiniteOptions<
73+
export type ManualUndefinedInitialDataInfiniteOptions<
7474
TQueryFnData,
7575
TError = DefaultError,
7676
TData = InfiniteData<TQueryFnData>,
7777
TQueryKey extends QueryKey = QueryKey,
7878
TPageParam = unknown,
79-
> = CreateImperativeInfiniteQueryOptions<
79+
> = CreateManualInfiniteQueryOptions<
8080
TQueryFnData,
8181
TError,
8282
TData,
@@ -101,14 +101,14 @@ export type UnusedSkipTokenDeclarativeInfiniteOptions<
101101
>
102102
>
103103

104-
export type UnusedSkipTokenImperativeInfiniteOptions<
104+
export type UnusedSkipTokenManualInfiniteOptions<
105105
TQueryFnData,
106106
TError = DefaultError,
107107
TData = InfiniteData<TQueryFnData>,
108108
TQueryKey extends QueryKey = QueryKey,
109109
TPageParam = unknown,
110110
> = WithoutSkipTokenQueryFn<
111-
CreateImperativeInfiniteQueryOptions<
111+
CreateManualInfiniteQueryOptions<
112112
TQueryFnData,
113113
TError,
114114
TData,
@@ -131,7 +131,7 @@ export type UnusedSkipTokenInfiniteOptions<
131131
TQueryKey,
132132
TPageParam
133133
>
134-
| UnusedSkipTokenImperativeInfiniteOptions<
134+
| UnusedSkipTokenManualInfiniteOptions<
135135
TQueryFnData,
136136
TError,
137137
TData,
@@ -154,13 +154,13 @@ export type DeclarativeDefinedInitialDataInfiniteOptions<
154154
> &
155155
RequiredInitialData<TQueryFnData, TPageParam>
156156

157-
export type ImperativeDefinedInitialDataInfiniteOptions<
157+
export type ManualDefinedInitialDataInfiniteOptions<
158158
TQueryFnData,
159159
TError = DefaultError,
160160
TData = InfiniteData<TQueryFnData>,
161161
TQueryKey extends QueryKey = QueryKey,
162162
TPageParam = unknown,
163-
> = CreateImperativeInfiniteQueryOptions<
163+
> = CreateManualInfiniteQueryOptions<
164164
TQueryFnData,
165165
TError,
166166
TData,
@@ -216,14 +216,14 @@ export function infiniteQueryOptions<
216216
TQueryKey extends QueryKey = QueryKey,
217217
TPageParam = unknown,
218218
>(
219-
options: ImperativeDefinedInitialDataInfiniteOptions<
219+
options: ManualDefinedInitialDataInfiniteOptions<
220220
TQueryFnData,
221221
TError,
222222
TData,
223223
TQueryKey,
224224
TPageParam
225225
>,
226-
): ImperativeDefinedInitialDataInfiniteOptions<
226+
): ManualDefinedInitialDataInfiniteOptions<
227227
TQueryFnData,
228228
TError,
229229
TData,
@@ -262,14 +262,14 @@ export function infiniteQueryOptions<
262262
TQueryKey extends QueryKey = QueryKey,
263263
TPageParam = unknown,
264264
>(
265-
options: UnusedSkipTokenImperativeInfiniteOptions<
265+
options: UnusedSkipTokenManualInfiniteOptions<
266266
TQueryFnData,
267267
TError,
268268
TData,
269269
TQueryKey,
270270
TPageParam
271271
>,
272-
): UnusedSkipTokenImperativeInfiniteOptions<
272+
): UnusedSkipTokenManualInfiniteOptions<
273273
TQueryFnData,
274274
TError,
275275
TData,
@@ -308,14 +308,14 @@ export function infiniteQueryOptions<
308308
TQueryKey extends QueryKey = QueryKey,
309309
TPageParam = unknown,
310310
>(
311-
options: ImperativeUndefinedInitialDataInfiniteOptions<
311+
options: ManualUndefinedInitialDataInfiniteOptions<
312312
TQueryFnData,
313313
TError,
314314
TData,
315315
TQueryKey,
316316
TPageParam
317317
>,
318-
): ImperativeUndefinedInitialDataInfiniteOptions<
318+
): ManualUndefinedInitialDataInfiniteOptions<
319319
TQueryFnData,
320320
TError,
321321
TData,

‎packages/angular-query-experimental/src/inject-infinite-query.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ import type {
2222
DefinedInitialDataInfiniteOptions,
2323
DeclarativeDefinedInitialDataInfiniteOptions,
2424
DeclarativeUndefinedInitialDataInfiniteOptions,
25-
ImperativeDefinedInitialDataInfiniteOptions,
26-
ImperativeUndefinedInitialDataInfiniteOptions,
25+
ManualDefinedInitialDataInfiniteOptions,
26+
ManualUndefinedInitialDataInfiniteOptions,
2727
UndefinedInitialDataInfiniteOptions,
2828
} from './infinite-query-options'
2929

@@ -43,7 +43,7 @@ export function injectInfiniteQuery<
4343
TQueryKey extends QueryKey = QueryKey,
4444
TPageParam = unknown,
4545
>(
46-
injectInfiniteQueryFn: () => ImperativeDefinedInitialDataInfiniteOptions<
46+
injectInfiniteQueryFn: () => ManualDefinedInitialDataInfiniteOptions<
4747
TQueryFnData,
4848
TError,
4949
TData,
@@ -80,7 +80,7 @@ export function injectInfiniteQuery<
8080
TQueryKey extends QueryKey = QueryKey,
8181
TPageParam = unknown,
8282
>(
83-
injectInfiniteQueryFn: () => ImperativeUndefinedInitialDataInfiniteOptions<
83+
injectInfiniteQueryFn: () => ManualUndefinedInitialDataInfiniteOptions<
8484
TQueryFnData,
8585
TError,
8686
TData,

‎packages/angular-query-experimental/src/types.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ export type CreateInfiniteQueryOptions<
8282
TPageParam = unknown,
8383
TMode extends InfiniteQueryMode | undefined = InfiniteQueryMode | undefined,
8484
> = TMode extends InfiniteQueryMode
85-
? CreateImperativeInfiniteQueryOptions<
85+
? CreateManualInfiniteQueryOptions<
8686
TQueryFnData,
8787
TError,
8888
TData,
@@ -115,7 +115,7 @@ export type CreateDeclarativeInfiniteQueryOptions<
115115
'suspense'
116116
>
117117

118-
export type CreateImperativeInfiniteQueryOptions<
118+
export type CreateManualInfiniteQueryOptions<
119119
TQueryFnData = unknown,
120120
TError = DefaultError,
121121
TData = TQueryFnData,

‎packages/query-core/src/__tests__/infiniteQueryBehavior.test.tsx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ describe('InfiniteQueryBehavior', () => {
7070
InfiniteData<number>,
7171
Error,
7272
number,
73-
'imperative'
73+
'manual'
7474
>
7575
| undefined
7676

@@ -213,11 +213,11 @@ describe('InfiniteQueryBehavior', () => {
213213
InfiniteData<number>,
214214
typeof key,
215215
number,
216-
'imperative'
216+
'manual'
217217
>(queryClient, {
218218
queryKey: key,
219219
queryFn,
220-
mode: 'imperative',
220+
mode: 'manual',
221221
initialPageParam: 0,
222222
})
223223

@@ -226,7 +226,7 @@ describe('InfiniteQueryBehavior', () => {
226226
InfiniteData<number>,
227227
Error,
228228
number,
229-
'imperative'
229+
'manual'
230230
>
231231
| undefined
232232

‎packages/query-core/src/__tests__/infiniteQueryObserver.test-d.tsx‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -98,62 +98,62 @@ describe('InfiniteQueryObserver', () => {
9898
InfiniteData<string>,
9999
ReturnType<typeof queryKey>,
100100
number,
101-
'imperative'
101+
'manual'
102102
>(queryClient, {
103103
queryKey: queryKey(),
104104
queryFn: ({ pageParam }) => String(pageParam),
105-
mode: 'imperative',
105+
mode: 'manual',
106106
initialPageParam: 1,
107107
})
108108

109109
observer.fetchNextPage({ pageParam: 2 })
110110
observer.fetchPreviousPage({ pageParam: 0, cancelRefetch: false })
111111

112-
// @ts-expect-error pageParam is required in imperative mode
112+
// @ts-expect-error pageParam is required in manual mode
113113
observer.fetchNextPage()
114114

115-
// @ts-expect-error pageParam is required in imperative mode
115+
// @ts-expect-error pageParam is required in manual mode
116116
observer.fetchPreviousPage()
117117
})
118118

119119
it('should reject missing mode / getNextPageParam', () => {
120-
// @ts-expect-error getNextPageParam is required unless mode is imperative
120+
// @ts-expect-error getNextPageParam is required unless mode is manual
121121
new InfiniteQueryObserver(queryClient, {
122122
queryKey: queryKey(),
123123
queryFn: ({ pageParam }) => String(pageParam),
124124
initialPageParam: 1,
125125
})
126126
})
127127

128-
it('should reject page param getters in imperative mode', () => {
129-
// @ts-expect-error getNextPageParam is not allowed in imperative mode
128+
it('should reject page param getters in manual mode', () => {
129+
// @ts-expect-error getNextPageParam is not allowed in manual mode
130130
new InfiniteQueryObserver<
131131
string,
132132
Error,
133133
InfiniteData<string>,
134134
ReturnType<typeof queryKey>,
135135
number,
136-
'imperative'
136+
'manual'
137137
>(queryClient, {
138138
queryKey: queryKey(),
139139
queryFn: ({ pageParam }) => String(pageParam),
140-
mode: 'imperative',
140+
mode: 'manual',
141141
initialPageParam: 1,
142142
getNextPageParam: () => 2,
143143
})
144144

145-
// @ts-expect-error getPreviousPageParam is not allowed in imperative mode
145+
// @ts-expect-error getPreviousPageParam is not allowed in manual mode
146146
new InfiniteQueryObserver<
147147
string,
148148
Error,
149149
InfiniteData<string>,
150150
ReturnType<typeof queryKey>,
151151
number,
152-
'imperative'
152+
'manual'
153153
>(queryClient, {
154154
queryKey: queryKey(),
155155
queryFn: ({ pageParam }) => String(pageParam),
156-
mode: 'imperative',
156+
mode: 'manual',
157157
initialPageParam: 1,
158158
getPreviousPageParam: () => 0,
159159
})

0 commit comments

Comments
 (0)