fix(types): error booleans shouldn't permanently be typed as false (#…

…7956) * fix(types): error booleans shouldn't permanently be typed as `false` * fix(types): error booleans shouldn't permanently be typed as `false` * chore: I don't understand these errors
TanStack · Aug 26, 2024 · b93941d · b93941d
1 parent 8cf7e2f
commit b93941d
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 7 deletions.
diff --git a/packages/query-core/src/__tests__/infiniteQueryObserver.test-d.tsx b/packages/query-core/src/__tests__/infiniteQueryObserver.test-d.tsx
@@ -51,8 +51,8 @@ describe('InfiniteQueryObserver', () => {
  expectTypeOf(result.data).toEqualTypeOf<InfiniteData<string, unknown>>()
  expectTypeOf(result.error).toEqualTypeOf<Error>()
  expectTypeOf(result.status).toEqualTypeOf<'error'>()
- expectTypeOf(result.isFetchNextPageError).toEqualTypeOf<false>()
- expectTypeOf(result.isFetchPreviousPageError).toEqualTypeOf<false>()
+ expectTypeOf(result.isFetchNextPageError).toEqualTypeOf<boolean>()
+ expectTypeOf(result.isFetchPreviousPageError).toEqualTypeOf<boolean>()
  }
 
  if (result.isSuccess) {

diff --git a/packages/query-core/src/types.ts b/packages/query-core/src/types.ts
@@ -853,8 +853,6 @@ export interface InfiniteQueryObserverRefetchErrorResult<
  isLoading: false
  isLoadingError: false
  isRefetchError: true
- isFetchNextPageError: false
- isFetchPreviousPageError: false
  isSuccess: false
  status: 'error'
 }

diff --git a/packages/react-query/src/__tests__/useInfiniteQuery.test-d.tsx b/packages/react-query/src/__tests__/useInfiniteQuery.test-d.tsx
@@ -117,3 +117,26 @@ describe('getNextPageParam / getPreviousPageParam', () => {
  >()
  })
 })
+
+describe('error booleans', () => {
+ it('should not be permanently `false`', () => {
+ const {
+ isFetchNextPageError,
+ isFetchPreviousPageError,
+ isLoadingError,
+ isRefetchError,
+ } = useInfiniteQuery({
+ queryKey: ['key'],
+ queryFn: ({ pageParam }) => {
+ return pageParam * 5
+ },
+ initialPageParam: 1,
+ getNextPageParam: () => undefined,
+ })
+
+ expectTypeOf(isFetchNextPageError).toEqualTypeOf<boolean>()
+ expectTypeOf(isFetchPreviousPageError).toEqualTypeOf<boolean>()
+ expectTypeOf(isLoadingError).toEqualTypeOf<boolean>()
+ expectTypeOf(isRefetchError).toEqualTypeOf<boolean>()
+ })
+})
diff --git a/packages/solid-query/src/__tests__/createInfiniteQuery.test.tsx b/packages/solid-query/src/__tests__/createInfiniteQuery.test.tsx
@@ -689,6 +689,7 @@ describe('useInfiniteQuery', () => {
  const states: Array<
  Partial<CreateInfiniteQueryResult<InfiniteData<number>>>
  > = []
+
  let isRefetch = false
 
  function Page() {
@@ -717,7 +718,7 @@ describe('useInfiniteQuery', () => {
  isFetchingNextPage: state.isFetchingNextPage,
  isFetchPreviousPageError: state.isFetchPreviousPageError,
  isFetchingPreviousPage: state.isFetchingPreviousPage,
- isRefetchError: state.isRefetchError,
+ isRefetchError: state.isRefetchError as true,
  isRefetching: state.isRefetching,
  })
  })
@@ -828,7 +829,7 @@ describe('useInfiniteQuery', () => {
  isFetchingNextPage: state.isFetchingNextPage,
  isFetchPreviousPageError: state.isFetchPreviousPageError,
  isFetchingPreviousPage: state.isFetchingPreviousPage,
- isRefetchError: state.isRefetchError,
+ isRefetchError: state.isRefetchError as true,
  isRefetching: state.isRefetching,
  })
  })
@@ -932,7 +933,7 @@ describe('useInfiniteQuery', () => {
  isFetchingNextPage: state.isFetchingNextPage,
  isFetchPreviousPageError: state.isFetchPreviousPageError,
  isFetchingPreviousPage: state.isFetchingPreviousPage,
- isRefetchError: state.isRefetchError,
+ isRefetchError: state.isRefetchError as true,
  isRefetching: state.isRefetching,
  })
  })