Skip to content

fix(angular-query): fix injectInfiniteQuery to narrow type #9653

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

fix(angular-query): fix injectInfiniteQuery to narrow type #9653

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
e3b11c0
fix: narrow injectInfiniteQuery type with initial data
mdm317 Sep 14, 2025
7744947
ci: apply automated fixes
autofix-ci[bot] Sep 14, 2025
6cdef16
Merge remote-tracking branch 'upstream/main' into fix-8984
mdm317 Sep 18, 2025
7e32fcd
Merge branch 'fix-8984' of https://github.com/mdm317/query into fix-8984
mdm317 Sep 18, 2025
428aa7f
fix: change to omit and fix function overload err
mdm317 Sep 18, 2025
c85e58a
fix: propagate narrowing type to all query results
mdm317 Sep 19, 2025
265ae8d
Merge branch 'main' into fix-8984
mdm317 Sep 19, 2025
29a7076
fix example type error
arnoud-dv Sep 21, 2025
ecb7fd3
Merge branch 'main' into fix-8984
lachlancollins Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
127 changes: 114 additions & 13 deletions packages/angular-query-experimental/src/__tests__/inject-infinite-query.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,121 @@ describe('injectInfiniteQuery', () => {
vi.useRealTimers()
})

test('should narrow type after isSuccess', () => {
const query = TestBed.runInInjectionContext(() => {
return injectInfiniteQuery(() => ({
queryKey: ['infiniteQuery'],
queryFn: ({ pageParam }) =>
sleep(0).then(() => 'data on page ' + pageParam),
initialPageParam: 0,
getNextPageParam: () => 12,
}))
describe('without initialData', () => {
test('should narrow type after isSuccess', () => {
const query = TestBed.runInInjectionContext(() => {
return injectInfiniteQuery(() => ({
queryKey: ['infiniteQuery'],
queryFn: ({ pageParam }) =>
sleep(0).then(() => 'data on page ' + pageParam),
initialPageParam: 0,
getNextPageParam: () => 12,
}))
})

if (query.isSuccess()) {
const data = query.data()
expectTypeOf(data).toEqualTypeOf<InfiniteData<string, unknown>>()
}
})

test('should narrow type after isPending', () => {
const query = TestBed.runInInjectionContext(() => {
return injectInfiniteQuery(() => ({
queryKey: ['infiniteQuery'],
queryFn: ({ pageParam }) =>
sleep(0).then(() => 'data on page ' + pageParam),
initialPageParam: 0,
getNextPageParam: () => 12,
}))
})

if (query.isPending()) {
const data = query.data()
expectTypeOf(data).toEqualTypeOf<undefined>()
}
})

test('should narrow type after isError', () => {
const query = TestBed.runInInjectionContext(() => {
return injectInfiniteQuery(() => ({
queryKey: ['infiniteQuery'],
queryFn: ({ pageParam }) =>
sleep(0).then(() => 'data on page ' + pageParam),
initialPageParam: 0,
getNextPageParam: () => 12,
}))
})

if (query.isError()) {
const error = query.error()
expectTypeOf(error).toEqualTypeOf<Error>()
}
})
})

describe('with initialData', () => {
test('should narrow type after isSuccess', () => {
const query = TestBed.runInInjectionContext(() => {
return injectInfiniteQuery(() => ({
queryKey: ['infiniteQuery'],
queryFn: ({ pageParam }) =>
sleep(0).then(() => 'data on page ' + pageParam),
initialPageParam: 0,
getNextPageParam: () => 12,
initialData: {
pageParams: [0, 1],
pages: ['page 0 data', 'page 1 data'],
},
}))
})

if (query.isSuccess()) {
const data = query.data()
expectTypeOf(data).toEqualTypeOf<InfiniteData<string, unknown>>()
}
})

test('should narrow type after isPending', () => {
const query = TestBed.runInInjectionContext(() => {
return injectInfiniteQuery(() => ({
queryKey: ['infiniteQuery'],
queryFn: ({ pageParam }) =>
sleep(0).then(() => 'data on page ' + pageParam),
initialPageParam: 0,
getNextPageParam: () => 12,
initialData: {
pageParams: [0, 1],
pages: ['page 0 data', 'page 1 data'],
},
}))
})

if (query.isPending()) {
const data = query.data()
expectTypeOf(data).toEqualTypeOf<InfiniteData<string, unknown>>()
}
})

if (query.isSuccess()) {
const data = query.data()
expectTypeOf(data).toEqualTypeOf<InfiniteData<string, unknown>>()
}
test('should narrow type after isError', () => {
const query = TestBed.runInInjectionContext(() => {
return injectInfiniteQuery(() => ({
queryKey: ['infiniteQuery'],
queryFn: ({ pageParam }) =>
sleep(0).then(() => 'data on page ' + pageParam),
initialPageParam: 0,
getNextPageParam: () => 12,
initialData: {
pageParams: [0, 1],
pages: ['page 0 data', 'page 1 data'],
},
}))
})

if (query.isError()) {
const error = query.error()
expectTypeOf(error).toEqualTypeOf<Error>()
}
})
})
})
3 changes: 2 additions & 1 deletion packages/angular-query-experimental/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,8 @@ export type DefinedCreateInfiniteQueryResult<
TData,
TError
>,
> = MapToSignals<TDefinedInfiniteQueryObserver>
> =BaseQueryNarrowing<TData, TError> &
MapToSignals<TDefinedInfiniteQueryObserver>

export interface CreateMutationOptions<
TData = unknown,
Expand Down
Loading