-
-
Notifications
You must be signed in to change notification settings - Fork 4.2k
fix(vue-query): accept optional infinite query initial data 🤖🤖🤖 #11539
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.
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
Closed
dijedontahiri
wants to merge
5
commits into
TanStack:main
from
dijedontahiri:fix/vue-infinite-optional-initial-data
Closed
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a53ea73
fix(vue-query): accept optional infinite query initial data
dijedontahiri 1b1a8cb
style(vue-query): format optional initial data type
dijedontahiri d0a4a8f
style(vue-query): format initial data regression cases
dijedontahiri 0d46d43
docs(vue-query): regenerate infinite query option references
dijedontahiri 9a1e30d
docs(vue-query): clarify defined initial data overload
dijedontahiri File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 @@ | ||
| --- | ||
| '@tanstack/vue-query': patch | ||
| --- | ||
|
|
||
| Allow optional initial data and initializer functions returning undefined in `infiniteQueryOptions`, while preserving the overload for guaranteed initial data. |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
106 changes: 106 additions & 0 deletions
106
packages/vue-query/src/__tests__/infiniteQueryOptions.initialData.test-d.ts
This file contains hidden or 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,106 @@ | ||
| import { describe, expectTypeOf, it } from 'vitest' | ||
| import { dataTagSymbol } from '@tanstack/query-core' | ||
| import { infiniteQueryOptions } from '../infiniteQueryOptions' | ||
| import { useInfiniteQuery } from '../useInfiniteQuery' | ||
| import type { InfiniteData } from '@tanstack/query-core' | ||
| import type { DefinedInitialDataInfiniteOptions } from '../infiniteQueryOptions' | ||
|
|
||
| const queryOptions = { | ||
| queryKey: ['initial-data'], | ||
| queryFn: ({ pageParam }: { pageParam: number }) => | ||
| Promise.resolve(`${pageParam}`), | ||
| initialPageParam: 0, | ||
| getNextPageParam: () => 1, | ||
| } | ||
|
|
||
| describe('infiniteQueryOptions initialData', () => { | ||
| it('accepts data that may be undefined without losing page inference', () => { | ||
| const createOptions = (initialData?: InfiniteData<string, number>) => | ||
| infiniteQueryOptions({ ...queryOptions, initialData }) | ||
|
|
||
| const options = createOptions() | ||
| const { data } = useInfiniteQuery(options) | ||
|
|
||
| expectTypeOf(data.value).toEqualTypeOf<InfiniteData<string> | undefined>() | ||
| expectTypeOf(options.queryKey[dataTagSymbol]).toEqualTypeOf< | ||
| InfiniteData<string> | ||
| >() | ||
| }) | ||
|
|
||
| it('accepts an initializer that may return undefined', () => { | ||
| const createOptions = (initialData?: InfiniteData<string, number>) => | ||
| infiniteQueryOptions({ | ||
| ...queryOptions, | ||
| initialData: () => initialData, | ||
| }) | ||
|
|
||
| const { data } = useInfiniteQuery(createOptions()) | ||
|
|
||
| expectTypeOf(data.value).toEqualTypeOf<InfiniteData<string> | undefined>() | ||
| }) | ||
|
|
||
| it('preserves select inference when initial data is optional', () => { | ||
| const createOptions = (initialData?: InfiniteData<string, number>) => | ||
| infiniteQueryOptions({ | ||
| ...queryOptions, | ||
| initialData, | ||
| select: (data) => { | ||
| expectTypeOf(data).toEqualTypeOf<InfiniteData<string, number>>() | ||
| return data.pages.length | ||
| }, | ||
| }) | ||
|
|
||
| const { data } = useInfiniteQuery(createOptions()) | ||
|
|
||
| expectTypeOf(data.value).toEqualTypeOf<number | undefined>() | ||
| }) | ||
|
|
||
| it('keeps the defined overload for a guaranteed initial value', () => { | ||
| const options = infiniteQueryOptions({ | ||
| ...queryOptions, | ||
| initialData: { pages: ['first'], pageParams: [0] }, | ||
| }) | ||
|
|
||
| expectTypeOf(options).toExtend< | ||
| DefinedInitialDataInfiniteOptions< | ||
| string, | ||
| Error, | ||
| InfiniteData<string>, | ||
| Array<string>, | ||
| number | ||
| > | ||
| >() | ||
| }) | ||
|
|
||
| it('keeps the defined overload for a guaranteed initializer', () => { | ||
| const options = infiniteQueryOptions({ | ||
| ...queryOptions, | ||
| initialData: () => ({ pages: ['first'], pageParams: [0] }), | ||
| }) | ||
|
|
||
| expectTypeOf(options).toExtend< | ||
| DefinedInitialDataInfiniteOptions< | ||
| string, | ||
| Error, | ||
| InfiniteData<string>, | ||
| Array<string>, | ||
| number | ||
| > | ||
| >() | ||
| }) | ||
|
|
||
| it('still accepts missing and explicitly undefined initial data', () => { | ||
| const absent = infiniteQueryOptions(queryOptions) | ||
| const explicit = infiniteQueryOptions({ | ||
| ...queryOptions, | ||
| initialData: undefined, | ||
| }) | ||
|
|
||
| expectTypeOf(useInfiniteQuery(absent).data.value).toEqualTypeOf< | ||
| InfiniteData<string> | undefined | ||
| >() | ||
| expectTypeOf(useInfiniteQuery(explicit).data.value).toEqualTypeOf< | ||
| InfiniteData<string> | undefined | ||
| >() | ||
| }) | ||
| }) |
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.