-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(react-query): make @suspensive/react-query v2 all naming conventi…
…on correctly like @tanstack/react-query v5 (#401) fix #253 # Overview <!-- A clear and concise description of what this pr is about. --> ## PR Checklist - [x] I did below actions if need 1. I read the [Contributing Guide](https://github.com/suspensive/react/blob/main/CONTRIBUTING.md) 2. I added documents and tests.
- Loading branch information
Showing
8 changed files
with
228 additions
and
647 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| '@suspensive/react-query': major | ||
| --- | ||
|
|
||
| fix(react-query): @suspensive/react-query v2's all naming convention correctly like @tanstack/react-query v5 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,8 @@ | ||
| export { useSuspenseQuery } from './useSuspenseQuery' | ||
| export type { | ||
| BaseUseSuspenseQueryResult, | ||
| UseSuspenseQueryOptions, | ||
| UseSuspenseQueryResultOnLoading, | ||
| UseSuspenseQueryResultOnSuccess, | ||
| } from './useSuspenseQuery' | ||
| export type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './useSuspenseQuery' | ||
| export { useSuspenseQueries } from './useSuspenseQueries' | ||
| export type { SuspenseQueriesOptions, SuspenseQueriesResults } from './useSuspenseQueries' | ||
| export { useSuspenseInfiniteQuery } from './useSuspenseInfiniteQuery' | ||
| export type { | ||
| BaseUseSuspenseInfiniteQueryResult, | ||
| UseSuspenseInfiniteQueryOptions, | ||
| UseSuspenseInfiniteQueryResultOnLoading, | ||
| UseSuspenseInfiniteQueryResultOnSuccess, | ||
| } from './useSuspenseInfiniteQuery' | ||
| export type { UseSuspenseInfiniteQueryOptions, UseSuspenseInfiniteQueryResult } from './useSuspenseInfiniteQuery' | ||
|
|
||
| export { QueryErrorBoundary } from './QueryErrorBoundary' |
121 changes: 60 additions & 61 deletions
121
packages/react-query/src/useSuspenseInfiniteQuery.test-d.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,72 @@ | ||
| /* eslint-disable react-hooks/rules-of-hooks */ | ||
| import type { InfiniteData } from '@tanstack/react-query' | ||
| import { expectTypeOf } from 'vitest' | ||
| import { describe, expectTypeOf, it } from 'vitest' | ||
| import { useSuspenseInfiniteQuery } from '../dist' | ||
|
|
||
| const queryKey = ['key'] as const | ||
| const queryFn = () => 'response' as const | ||
| const boolean = Math.random() > 0.5 | ||
|
|
||
| type AwaitedQueryFnReturn = Awaited<ReturnType<typeof queryFn>> | ||
| // @ts-expect-error no arg | ||
| useSuspenseInfiniteQuery() | ||
|
|
||
| // arg1:queryKey, arg2: queryFn, arg3: options | ||
| expectTypeOf( | ||
| useSuspenseInfiniteQuery(queryKey, queryFn, { | ||
| enabled: true, | ||
| }).data | ||
| ).toEqualTypeOf<InfiniteData<AwaitedQueryFnReturn>>() | ||
| expectTypeOf( | ||
| useSuspenseInfiniteQuery(queryKey, queryFn, { | ||
| enabled: boolean, | ||
| }).data | ||
| ).toEqualTypeOf<InfiniteData<AwaitedQueryFnReturn> | undefined>() | ||
| expectTypeOf( | ||
| useSuspenseInfiniteQuery(queryKey, queryFn, { | ||
| enabled: false, | ||
| }).data | ||
| ).toEqualTypeOf<undefined>() | ||
| // @ts-expect-error no suspense | ||
| useSuspenseInfiniteQuery({ queryKey, queryFn, suspense: boolean }) | ||
| // @ts-expect-error no suspense | ||
| useSuspenseInfiniteQuery(queryKey, { queryFn, suspense: boolean }) | ||
| // @ts-expect-error no suspense | ||
| useSuspenseInfiniteQuery(queryKey, queryFn, { suspense: boolean }) | ||
|
|
||
| // arg1:queryKey, arg2: options | ||
| expectTypeOf( | ||
| useSuspenseInfiniteQuery(queryKey, { | ||
| queryFn, | ||
| enabled: true, | ||
| }).data | ||
| ).toEqualTypeOf<InfiniteData<AwaitedQueryFnReturn>>() | ||
| expectTypeOf( | ||
| useSuspenseInfiniteQuery(queryKey, { | ||
| queryFn, | ||
| enabled: boolean, | ||
| }).data | ||
| ).toEqualTypeOf<InfiniteData<AwaitedQueryFnReturn> | undefined>() | ||
| expectTypeOf( | ||
| useSuspenseInfiniteQuery(queryKey, { | ||
| queryFn, | ||
| enabled: false, | ||
| }).data | ||
| ).toEqualTypeOf<undefined>() | ||
| // @ts-expect-error no useErrorBoundary | ||
| useSuspenseInfiniteQuery({ queryKey, queryFn, useErrorBoundary: boolean }) | ||
| // @ts-expect-error no useErrorBoundary | ||
| useSuspenseInfiniteQuery(queryKey, { queryFn, useErrorBoundary: boolean }) | ||
| // @ts-expect-error no useErrorBoundary | ||
| useSuspenseInfiniteQuery(queryKey, queryFn, { useErrorBoundary: boolean }) | ||
|
|
||
| // arg1: options | ||
| expectTypeOf( | ||
| useSuspenseInfiniteQuery({ | ||
| queryKey, | ||
| queryFn, | ||
| enabled: true, | ||
| }).data | ||
| ).toEqualTypeOf<InfiniteData<AwaitedQueryFnReturn>>() | ||
| expectTypeOf( | ||
| useSuspenseInfiniteQuery({ | ||
| queryKey, | ||
| queryFn, | ||
| enabled: boolean, | ||
| }).data | ||
| ).toEqualTypeOf<InfiniteData<AwaitedQueryFnReturn> | undefined>() | ||
| expectTypeOf( | ||
| useSuspenseInfiniteQuery({ | ||
| queryKey, | ||
| queryFn, | ||
| enabled: false, | ||
| }).data | ||
| ).toEqualTypeOf<undefined>() | ||
| // @ts-expect-error no enabled | ||
| useSuspenseInfiniteQuery({ queryKey, queryFn, enabled: boolean }) | ||
| // @ts-expect-error no enabled | ||
| useSuspenseInfiniteQuery(queryKey, { queryFn, enabled: boolean }) | ||
| // @ts-expect-error no enabled | ||
| useSuspenseInfiniteQuery(queryKey, queryFn, { enabled: boolean }) | ||
|
|
||
| // @ts-expect-error no arg | ||
| useSuspenseInfiniteQuery() | ||
| // @ts-expect-error no placeholderData | ||
| useSuspenseInfiniteQuery({ queryKey, queryFn, placeholderData: boolean }) | ||
| // @ts-expect-error no placeholderData | ||
| useSuspenseInfiniteQuery(queryKey, { queryFn, placeholderData: boolean }) | ||
| // @ts-expect-error no placeholderData | ||
| useSuspenseInfiniteQuery(queryKey, queryFn, { placeholderData: boolean }) | ||
|
|
||
| // @ts-expect-error no isPlaceholderData | ||
| useSuspenseInfiniteQuery(queryKey, queryFn).isPlaceholderData | ||
| // @ts-expect-error no isPlaceholderData | ||
| useSuspenseInfiniteQuery(queryKey, queryFn, {}).isPlaceholderData | ||
| // @ts-expect-error no isPlaceholderData | ||
| useSuspenseInfiniteQuery(queryKey, { queryFn }).isPlaceholderData | ||
| // @ts-expect-error no isPlaceholderData | ||
| useSuspenseInfiniteQuery({ queryKey, queryFn }).isPlaceholderData | ||
|
|
||
| describe('useSuspenseInfiniteQuery', () => { | ||
| it("'s type check", () => { | ||
| // data is always defined | ||
| expectTypeOf(useSuspenseInfiniteQuery(queryKey, queryFn).data).toEqualTypeOf< | ||
| InfiniteData<Awaited<ReturnType<typeof queryFn>>> | ||
| >() | ||
| expectTypeOf(useSuspenseInfiniteQuery(queryKey, queryFn, {}).data).toEqualTypeOf< | ||
| InfiniteData<Awaited<ReturnType<typeof queryFn>>> | ||
| >() | ||
| expectTypeOf(useSuspenseInfiniteQuery(queryKey, { queryFn }).data).toEqualTypeOf< | ||
| InfiniteData<Awaited<ReturnType<typeof queryFn>>> | ||
| >() | ||
| expectTypeOf(useSuspenseInfiniteQuery({ queryKey, queryFn }).data).toEqualTypeOf< | ||
| InfiniteData<Awaited<ReturnType<typeof queryFn>>> | ||
| >() | ||
|
|
||
| // status is always 'success' | ||
| expectTypeOf(useSuspenseInfiniteQuery(queryKey, queryFn).status).toEqualTypeOf<'success'>() | ||
| expectTypeOf(useSuspenseInfiniteQuery(queryKey, queryFn, {}).status).toEqualTypeOf<'success'>() | ||
| expectTypeOf(useSuspenseInfiniteQuery(queryKey, { queryFn }).status).toEqualTypeOf<'success'>() | ||
| expectTypeOf(useSuspenseInfiniteQuery({ queryKey, queryFn }).status).toEqualTypeOf<'success'>() | ||
| }) | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.