Skip to content

fix(react-query): Allow optional initialData object in infiniteQueryOptions#8157

Merged
TkDodo merged 2 commits intoTanStack:mainfrom
jimmycallin:infinitequeryoptions-fix
Oct 9, 2024
Merged

fix(react-query): Allow optional initialData object in infiniteQueryOptions#8157
TkDodo merged 2 commits intoTanStack:mainfrom
jimmycallin:infinitequeryoptions-fix

Conversation

@jimmycallin
Copy link
Copy Markdown
Contributor

@jimmycallin jimmycallin commented Oct 9, 2024

This is a follow-up on #8154 and the post-merge discussion.

This resolves a TS issue where you cannot pass an optional initialData object to the infiniteQueryOptions function. The previous referred solution only handled initialData callback functions.

@jimmycallin jimmycallin mentioned this pull request Oct 9, 2024
Merged
@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented Oct 9, 2024 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 2cd4d37. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Oct 9, 2024

Open in Stackblitz

More templates

@tanstack/angular-query-devtools-experimental

pnpm add https://pkg.pr.new/@tanstack/angular-query-devtools-experimental@8157

@tanstack/angular-query-experimental

pnpm add https://pkg.pr.new/@tanstack/angular-query-experimental@8157

@tanstack/eslint-plugin-query

pnpm add https://pkg.pr.new/@tanstack/eslint-plugin-query@8157

@tanstack/query-async-storage-persister

pnpm add https://pkg.pr.new/@tanstack/query-async-storage-persister@8157

@tanstack/query-broadcast-client-experimental

pnpm add https://pkg.pr.new/@tanstack/query-broadcast-client-experimental@8157

@tanstack/query-core

pnpm add https://pkg.pr.new/@tanstack/query-core@8157

@tanstack/query-devtools

pnpm add https://pkg.pr.new/@tanstack/query-devtools@8157

@tanstack/query-persist-client-core

pnpm add https://pkg.pr.new/@tanstack/query-persist-client-core@8157

@tanstack/query-sync-storage-persister

pnpm add https://pkg.pr.new/@tanstack/query-sync-storage-persister@8157

@tanstack/react-query-devtools

pnpm add https://pkg.pr.new/@tanstack/react-query-devtools@8157

@tanstack/react-query

pnpm add https://pkg.pr.new/@tanstack/react-query@8157

@tanstack/react-query-next-experimental

pnpm add https://pkg.pr.new/@tanstack/react-query-next-experimental@8157

@tanstack/react-query-persist-client

pnpm add https://pkg.pr.new/@tanstack/react-query-persist-client@8157

@tanstack/solid-query-devtools

pnpm add https://pkg.pr.new/@tanstack/solid-query-devtools@8157

@tanstack/solid-query

pnpm add https://pkg.pr.new/@tanstack/solid-query@8157

@tanstack/solid-query-persist-client

pnpm add https://pkg.pr.new/@tanstack/solid-query-persist-client@8157

@tanstack/svelte-query

pnpm add https://pkg.pr.new/@tanstack/svelte-query@8157

@tanstack/svelte-query-persist-client

pnpm add https://pkg.pr.new/@tanstack/svelte-query-persist-client@8157

@tanstack/svelte-query-devtools

pnpm add https://pkg.pr.new/@tanstack/svelte-query-devtools@8157

@tanstack/vue-query-devtools

pnpm add https://pkg.pr.new/@tanstack/vue-query-devtools@8157

@tanstack/vue-query

pnpm add https://pkg.pr.new/@tanstack/vue-query@8157

commit: 2cd4d37

@codecov
Copy link
Copy Markdown

codecov Bot commented Oct 9, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.89%. Comparing base (2fe16e5) to head (2cd4d37).
Report is 18 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #8157       +/-   ##
===========================================
+ Coverage   45.41%   81.89%   +36.48%     
===========================================
  Files         200       26      -174     
  Lines        7456      359     -7097     
  Branches     1696       99     -1597     
===========================================
- Hits         3386      294     -3092     
+ Misses       3694       56     -3638     
+ Partials      376        9      -367
Components Coverage Δ
@tanstack/angular-query-devtools-experimental ∅ <ø> (∅)
@tanstack/angular-query-experimental ∅ <ø> (∅)
@tanstack/eslint-plugin-query ∅ <ø> (∅)
@tanstack/query-async-storage-persister ∅ <ø> (∅)
@tanstack/query-broadcast-client-experimental ∅ <ø> (∅)
@tanstack/query-codemods ∅ <ø> (∅)
@tanstack/query-core ∅ <ø> (∅)
@tanstack/query-devtools ∅ <ø> (∅)
@tanstack/query-persist-client-core ∅ <ø> (∅)
@tanstack/query-sync-storage-persister ∅ <ø> (∅)
@tanstack/react-query 93.12% <100.00%> (ø)
@tanstack/react-query-devtools 10.00% <ø> (ø)
@tanstack/react-query-next-experimental ∅ <ø> (∅)
@tanstack/react-query-persist-client 100.00% <ø> (ø)
@tanstack/solid-query ∅ <ø> (∅)
@tanstack/solid-query-devtools ∅ <ø> (∅)
@tanstack/solid-query-persist-client ∅ <ø> (∅)
@tanstack/svelte-query ∅ <ø> (∅)
@tanstack/svelte-query-devtools ∅ <ø> (∅)
@tanstack/svelte-query-persist-client ∅ <ø> (∅)
@tanstack/vue-query ∅ <ø> (∅)
@tanstack/vue-query-devtools ∅ <ø> (∅)

@TkDodo TkDodo merged commit 329b5f8 into TanStack:main Oct 9, 2024
zemnmez-renovate-bot added a commit to zemn-me/monorepo that referenced this pull request Oct 9, 2024
@zemnmez-renovate-bot
fix(deps): update dependency @tanstack/react-query to v5.59.8
fd9ee2e 
##### v5.59.8 (`https://github.com/TanStack/query/releases/tag/v5.59.8`)

Version 5.59.8 - 10/9/24, 7:10 PM

#### Changes

##### Fix

-   allow optional initialData object ([#8157](TanStack/query#8157)) ([`329b5f8`](TanStack/query@329b5f8)) by Jimmy Callin

#### Packages

-   [@tanstack/react-query](https://github.com/tanstack/react-query)[@5](https://github.com/5).59.8
-   [@tanstack/react-query-devtools](https://github.com/tanstack/react-query-devtools)[@5](https://github.com/5).59.8
-   [@tanstack/react-query-persist-client](https://github.com/tanstack/react-query-persist-client)[@5](https://github.com/5).59.8
-   [@tanstack/react-query-next-experimental](https://github.com/tanstack/react-query-next-experimental)[@5](https://github.com/5).59.8
github-merge-queue Bot pushed a commit to zemn-me/monorepo that referenced this pull request Oct 9, 2024
@zemnmez-renovate-bot
fix(deps): update dependency @tanstack/react-query to v5.59.8
cb2e014 
##### v5.59.8 (`https://github.com/TanStack/query/releases/tag/v5.59.8`)

Version 5.59.8 - 10/9/24, 7:10 PM

#### Changes

##### Fix

-   allow optional initialData object ([#8157](TanStack/query#8157)) ([`329b5f8`](TanStack/query@329b5f8)) by Jimmy Callin

#### Packages

-   [@tanstack/react-query](https://github.com/tanstack/react-query)[@5](https://github.com/5).59.8
-   [@tanstack/react-query-devtools](https://github.com/tanstack/react-query-devtools)[@5](https://github.com/5).59.8
-   [@tanstack/react-query-persist-client](https://github.com/tanstack/react-query-persist-client)[@5](https://github.com/5).59.8
-   [@tanstack/react-query-next-experimental](https://github.com/tanstack/react-query-next-experimental)[@5](https://github.com/5).59.8
@sungpaks
Copy link
Copy Markdown
Contributor

sungpaks commented Oct 10, 2024

I like what you did!

Then how about queryOptions?
UndefinedInitialDataOptions still be like :
initialData?: undefined | InitialDataFunction<NonUndefinedGuard<TQueryFnData>>
just function, does not care about an object

Does this need to be fixed too?
@TkDodo @jimmycallin

@TkDodo
Copy link
Copy Markdown
Collaborator

TkDodo commented Oct 10, 2024

Sure, if we can reproduce a situation that fails, please file a PR with a failing test and a fix :)

@jimmycallin jimmycallin deleted the infinitequeryoptions-fix branch October 10, 2024 07:41
@sungpaks sungpaks mentioned this pull request Oct 10, 2024
Merged
@ipanasenko
Copy link
Copy Markdown

ipanasenko commented Oct 24, 2024 •
edited
Loading

Should this work in infiniteQueryOptions + useSuspenseInfiniteQuery combo?
It works fine when passing query config directly, but when using infiniteQueryOptions - TS fails.
https://www.typescriptlang.org/play/?#code/JYWwDg9gTgLgBAbzgVwM4FMDKazoHYYCSeAZsHsDOgIrLpQCeANHOWRVbfQwPJgzAIBOAF84JKBBBwARAAEYAQwJKAxgGsA9FHSLVMALQBHOoxkBuAFCWSyPPsF44MABY1Tvfo9QAKJOUpgRQAbABFFJVEALkRWDiCwiMUAfhikdAAPRXBg9BiYKDpRUQBKREs4OB0YZCgnNgDODz4BIV8ECsq4E24AaXQGGIBtGUzssFyZAF0mTsqexgAxPBjFVAZ7OB8ygF4APjjAkPClWa7DgWOkmMaEk8U5ruTYsEUAc3RUYdurpRm4V4fAAKiig2S+cCGU1Ej0qMTsABN0Ox0Aizl0PjAAHKZGAg4Gg7IxbZwfZwACM6MqP2C+PQILBIBilM6IhKVhE1ls9laTjQ6AA6mCwLgoFxGOS-Bc7klorEafdUrExjk8s5CuhimzypVqrU+RhsKhcAR0MR2JR3Nw-I8Fgx+oNIaMsqrplTuh5lqt1psSWSFUl3QGlDd4r8HudKs8kIDPt8w4k-ixYwzwcNoZzI3B4XgkSi0Y9MTiMnj3vTCUytrsDizzjS6anK7XShyuXYHEIUBghYoRfRxQwAExS4OKOX+BOKtJwFUTNUFIpibUdXXoGp1LtYHD4IikRpWxg+VwHzy89qjtnsywiIA

Let me know if I need to open separate issue regarding this

This was referenced Oct 31, 2024
Closed
Merged
@muhiddinjv muhiddinjv mentioned this pull request Oct 31, 2024
Closed
@Bancha-t Bancha-t mentioned this pull request Oct 31, 2024
Open
@Bonniemarie216 Bonniemarie216 mentioned this pull request Oct 31, 2024
Open
This was referenced Nov 2, 2024
Closed
Closed
@jwinr jwinr mentioned this pull request Nov 4, 2024
Merged
@CalPinSW CalPinSW mentioned this pull request Nov 5, 2024
Merged
@GouravNG GouravNG mentioned this pull request Nov 5, 2024
Open
This was referenced Nov 7, 2024
Closed
Merged
@muhiddinjv muhiddinjv mentioned this pull request Nov 7, 2024
Closed
@doperiddle doperiddle mentioned this pull request Nov 8, 2024
Merged
@snyk-io snyk-io Bot mentioned this pull request Nov 9, 2024
Closed
@muhammadahsanmirza muhammadahsanmirza mentioned this pull request Nov 10, 2024
Open
@JulianFl JulianFl mentioned this pull request Nov 10, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TkDodo TkDodo TkDodo approved these changes

Assignees

No one assigned

Labels

package: react-query

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jimmycallin @sungpaks @TkDodo @ipanasenko