0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
Commit graph

80 commits

Author SHA1 Message Date
Wonsuk Choi
2a495979b4
docs(query-core): add JSDoc for shared option and registry types (#11552) 2026-09-19 18:08:15 +09:00
Wonsuk Choi
54929cf71f
docs(query-core): add JSDoc for 'initialPageParam' (#11551) 2026-09-19 17:27:33 +09:00
Wonsuk Choi
8f6d322a5a
docs(query-core): add JSDoc for 'MutationOptions' (#11550) 2026-09-19 16:51:40 +09:00
Wonsuk Choi
d346e85f01
docs(*): promote default values from prose to '@defaultValue' tags (#11538) 2026-09-18 17:16:33 +09:00
Wonsuk Choi
992c94234c
docs(query-core): inline option type aliases in generated reference docs (#11534)
* docs(query-core): inline option type aliases in generated reference docs

* docs(query-core): inline retry, notify and remaining option aliases
2026-09-18 17:08:56 +09:00
Wonsuk Choi
e0faf4d594
docs(*): render reference property lists as tables (#11533) 2026-09-18 16:53:17 +09:00
autofix-ci[bot]
bb9d31306f
ci: apply automated fixes 2026-09-18 00:43:18 +00:00
Wonsuk Choi
00059b8796
docs(*): regenerate reference docs to fix stale source links (#11521) 2026-09-17 10:05:02 +09:00
Wonsuk Choi
dcc2215986
docs(*): regenerate reference docs to fix stale source links (#11520) 2026-09-17 09:55:55 +09:00
Ahmet Tınastepe
12027efd5c
fix(vue-query): widen 'queryOptions' input to match 'useQuery' (#11439)
* fix(vue-query): widen 'queryOptions' input to match 'useQuery'

* chore: generate-docs

* chore: changeset

---------

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
2026-09-15 09:00:40 +02:00
Kevin Van Cott
77647e96b5
docs(vue): fix reactivity guide heading hierarchy (#11466) 2026-09-14 15:25:17 +02:00
Wonsuk Choi
e57f8163b1
docs(query-core): add JSDoc across the package and expose it in generated reference docs (#11438)
* docs(query-core): add JSDoc across the package and expose it in generated reference docs

* docs(config.json): add sidebar entries for newly generated query-core reference docs

* docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc

* docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference

* docs(query-core): regenerate reference docs after merging main

* docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type

* fix(query-devtools): drop unnecessary 'query-core' project reference

* docs(query-core): document missing default values and normalize 'Defaults to' spacing

* docs(query-core): fix 'environmentManager' JSDoc example
2026-09-07 18:22:38 +02:00
Wonsuk Choi
1a51bb80bf
docs(*): clarify 'Promise.all' only waits for all mutateAsync calls when they succeed (#11435) 2026-09-07 00:31:27 +09:00
Peter Budai
aaf4ad94a5
docs(vue-query): skip hydration when Nuxt state is null (#11429)
fix(ssr): ensure hydration only occurs when vueQueryState is not null
2026-09-06 16:55:42 +02:00
Wonsuk Choi
309508612a
docs(vue-query): add JSDoc and generate reference docs with TypeDoc (#11378)
* docs(vue-query): add JSDoc across the package

* docs(vue-query): generate reference docs with TypeDoc

* docs(config): register vue-query TypeDoc reference pages

* docs(vue-query): preserve dehydrate/hydrate option docs and fix reference links

* docs(config): reorder vue-query reference nav to list 'Functions' first

* docs(config): reorder vue-query 'Functions' entries to match react/preact grouping

* docs(vue-query): restore Suspense guide link and 'placeholderData' behavior note lost in TypeDoc migration

* docs(vue-query): correct JSDoc accuracy issues and reactivity bugs

* docs(vue-query): fix invalidateQueries example that invalidated every query, add whole-options getter example

* docs(vue-query): add examples for the mutationOptions and useInfiniteQuery getter overloads

* docs(vue-query): add react-parity examples for select, skipToken, keepPreviousData, optimistic updates, and infinite scroll

* docs(vue-query): add queryOptions select typing example to useQueries

* docs(vue-query): disconnect IntersectionObserver on unmount, drop non-null assertion in skipToken examples

* docs(vue-query): add 'skipToken' factory example to 'queryOptions'

* docs(vue-query): correct 'queryKey' reactive-getter claim in 'useQuery'/'useInfiniteQuery'

* docs(vue-query): correct 'queryKey' reactive-getter claim in 'QueryOptions' type JSDoc

* docs(vue-query): fix reversed claim that 'queryKey' entries can't be reactive getters
2026-09-05 13:29:11 +09:00
Wonsuk Choi
4c568a28c8
docs(react-query): generate reference docs with TypeDoc (#11366)
* docs(vue-query,solid-query): inline react reference content instead of 'ref'-ing hand-written react docs

* docs(react-query): generate reference docs with TypeDoc

* docs(vue-query,solid-query): fix dangling suspense-hook links left over from the react content copy

* docs(solid-query): apply solid's callback call form to inlined reference examples

* docs(react-query): correct inaccurate JSDoc statements flagged in review

* docs(vue-query,solid-query): fix reactivity-aware examples and inaccurate type signatures flagged in review

* docs(vue-query,solid-query): fix remaining type/behavior inaccuracies flagged in second review

* docs(react-query): stop implying a default queryFn defers a fetch the way 'enabled: false' does

* docs(vue-query): mark 'mutate'/'mutateAsync' per-call options as optional
2026-09-02 16:06:54 +09:00
Ben Younes
b8517d3173
docs(vue-query): explain why reactive() is needed for result narrowing (#10580)
The type narrowing example wraps useQuery() in reactive() without saying
why, so destructuring the result directly and then checking isSuccess
looks like it should work (#9244). Spell out that reactive() is what
flattens the refs into one discriminated union, and show the
data.value !== undefined check as the alternative when reactive() is not
an option.

Pin both shapes with type tests: the non-reactive result exposes
Ref<T> | Ref<undefined>, and narrowing on data.value refines the ref
itself.

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
2026-08-22 10:20:36 +02:00
Ciarán Curley
97ce30b51e
Vue: add new impertive methods to vue proxy QueryClient (#11208)
* feat(vue-query): add new methods to vue-query

* docs(vue-query): docs for new impertive methods for Vue

* fix(vue-query): remove getter options from impertive methods

There is no evidence that the () => queryOptions getter type is
properly used by `fetchQuery` et al, as while it accepts a getter in the
types, it doens't resolve the function at runtime (as opposed to
`useQuery`). Removing the type from `query` and `fetchQuery` and
documenting calling getters impertivly as a workaround.

* Update packages/vue-query/src/queryClient.ts

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>

* Update packages/vue-query/src/usePrefetchQuery.ts

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>

---------

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
2026-08-20 17:12:42 +02:00
Wonsuk Choi
6423f9eb9e
docs(vue-query/reference): hide React-only 'React.use()' mention from useInfiniteQuery (#11203) 2026-08-17 04:24:43 +09:00
Wonsuk Choi
0785da5510
docs(vue-query/guides/ssr): fix 'queryKey' to use array form (#11202) 2026-08-17 03:24:57 +09:00
hamed-bavar
bdfbeadb70
docs(vue-query/guides/suspense): update example to v5 object syntax (#11159)
docs(vue-query): update suspense guide example to v5 object syntax
2026-08-17 03:08:59 +09:00
max
79d2384db5
docs(*): fix 'homogenous', 'stoage', 'supressed', 'compoennts' spelling typos (#11040)
* fix: correct spelling typos across docs, examples, and source comments

- homogenous -> homogeneous in 7 useQueries/createQueries source files
- stoage -> storage in react and vue createPersister docs
- supressed -> suppressed in react and angular pagination examples
- compoennts -> components in solid-start-streaming example

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* docs(react-query/useSuspenseQueries): correct 'homogenous' typo to 'homogeneous' in comment

---------

Co-authored-by: maxtaran2010 <ocotifuzo727@gmail.com>
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: Wonsuk Choi <sukvvon@gmail.com>
2026-07-13 14:06:03 +09:00
Dmytro Borysov
ad57c81fd3
docs(devtools): make markdown consistent (#10987)
Currently there is a bug, which prevents proper rendering of the links if there are both MD & HTML syntax in the same line (see https://tanstack.com/query/latest/docs/framework/react/devtools), probably should be fixed in @tanstack/markdown. Not sure that the source code of this package is published?

In the meantime, I just converted all links to html.

Converting everything (logos) to markdown won't work because we need to set width/height, which can't be done in markdown
2026-06-27 21:50:32 +02:00
Wonsuk Choi
dcc4a161d4
docs(framework/vue/devtools): inline the toggle and 'onClose' handler in the 'Embedded Mode' example to match the other adapters (#10856) 2026-06-01 17:07:14 +09:00
Wonsuk Choi
b1337cd568
docs(framework/vue/devtools): align the 'Embedded Mode' example with the other adapters and add the missing 'ref' import (#10855) 2026-06-01 16:23:30 +09:00
Wonsuk Choi
a79fc8d03b
docs(framework/vue/devtools): correct 'your React app' typo to 'your Vue app' in the Embedded Mode section (#10854) 2026-06-01 15:27:48 +09:00
Dami Oyeniyi
0d63459555
docs(devtools): correct 'errorTypes' type to array (#10634)
docs(devtools): document errorTypes as array
2026-05-05 12:08:07 +09:00
Wonsuk Choi
bf2546feb0
docs(devtools): add missing 'theme' option (#10621) 2026-05-02 10:50:20 +09:00
Wonsuk Choi
868577d5da
docs(devtools): align logo, panel, and option union descriptions across docs and JSDoc (#10617)
* docs(devtools): replace framework-specific logo with 'TanStack logo' to match the actual rendered component

* docs(vue-query/devtools): replace 'React Query' panel leftover with 'Vue Query'

* docs(devtools): replace framework-specific logo with 'TanStack logo' and use adapter naming for 'devtools panel' in JSDoc

* docs(devtools): add missing 'relative' to JSDoc 'buttonPosition' union

* chore(.changeset): add changeset for devtools logo, panel, and 'buttonPosition' union alignment

* docs(preact-query-devtools): add missing 'position' union to JSDoc
2026-05-01 16:34:40 +09:00
Dami Oyeniyi
4ef364ac3d
docs(devtools): add 'relative' to Vue/Solid 'buttonPosition' and fix Vue 'style' type (#10608)
docs(devtools): align Vue and Solid option types
2026-04-29 23:29:29 +09:00
Dami Oyeniyi
3d1a62e63b
fix(devtools): change onClose callback type from () => unknown to () … (#10118)
* fix(devtools): change onClose callback type from () => unknown to () => void

* Fix onClose callback type in devtools

Updated onClose callback type in devtools to improve type safety.

* chore(changeset): fixed truncated changeset description

---------

Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>
2026-04-25 17:40:17 +02:00
Wonsuk Choi
f279ad2488
feat(vue-query): add 'mutationOptions' (#10381)
* feat(vue-query): add 'mutationOptions'

* ci: apply automated fixes

* chore(.changeset): add changeset for 'mutationOptions' in vue-query

* feat(vue-query/mutationOptions): add getter support and fix test descriptions to match actual behavior

* refactor(vue-query): rename 'VueMutationOptions' to 'MutationOptions'

* docs(vue-query): add 'mutationOptions' reference page

* test(vue-query/mutationOptions): add runtime test for getter without 'mutationKey'

* docs(vue-query): add 'mutationOptions' to config.json navigation

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-04-11 19:49:32 +02:00
thalassophilia
b97513f288
feat(vue-query): add usePrefetchQuery and usePrefetchInfiniteQuery (#10372)
* feat(vue-query): add prefetch composables

- Add usePrefetchQuery and usePrefetchInfiniteQuery to vue-query.
- Includes runtime and type tests, plus a changeset

* docs(vue-query): document prefetch composables

* revert unrelated change

* ci: apply automated fixes

---------

Co-authored-by: Damian Osipiuk <osipiukd+git@gmail.com>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-04-11 15:27:47 +02:00
Zelys
67b12ae1a0
docs: add polling guide (#10330)
* docs(react): add polling guide

Adds a dedicated guide for refetchInterval-based polling. The option was
only mentioned in passing in important-defaults.md with no explanation of
how it works, how to adapt it dynamically, or how it interacts with window
focus, networkMode, and the enabled flag.

Covers:
- Basic setup and independence from staleTime
- Dynamic intervals via function form
- refetchIntervalInBackground for dashboards / always-on UIs
- Disabling window-focus refetching for fullscreen game and kiosk UIs
- Pausing polling with the enabled flag
- networkMode: 'always' for unreliable navigator.onLine environments
- Deduplication behavior across multiple observers

Updates config.json to add the guide to the React sidebar between
Window Focus Refetching and Disabling/Pausing Queries.
Adds a cross-reference in important-defaults.md.

* docs(react/polling): add example markers for framework portability

* docs(react): fix deduplication note — timers are per observer, not per query

* docs(react): address review feedback on polling guide

- Remove staleTime enumeration; link to Important Defaults instead
- Remove game/kiosk focus management examples (scope creep)
- Rewrite pausing polling to use refetchInterval function instead of enabled: false
- Fix offline support section: connectivity uses online/offline events, not navigator.onLine
- Fix deduplication note: remove queuing implication and em dash
- Add non-browser environments note pointing to React Native guide

* docs(solid,vue): add polling guide framework ports

* docs: wrap React Native section in markers for framework port exclusion

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-04-01 11:04:45 +02:00
Wonsuk Choi
0da627ba70
docs({solid,vue}-query/broadcastQueryClient): remove unnecessary 'replace' that doesn't match source content (#10193) 2026-02-26 17:06:46 +01:00
Martin Meixger
14c0ec89d0
docs: fix missing param in vue infinite queries sample (#10004)
* docs: fix missing param in vue infinite queries sample

Add initialPageParam to useInfiniteQuery

* docs: fix missing param in vue infinite queries sample
2025-12-30 23:27:54 +01:00
Lachlan Collins
5ad78fc4ad
docs: correct local relative links (#9947)
* docs: correct local relative links

* Update links

* Slight tweaks

* String
2025-12-05 22:39:25 +11:00
Stanyslas Bres
8b387341eb
docs(vue): change query keys example to typescript (#9907)
* docs(vue): change query keys example to typescript

This example is written in Javascript, and the fact that `todoId` is a `Ref` is a bit hard to identify.

I propose to migrate this example to Typescript, with an import to Vue's Ref type and make the parameter to the example composable explicit.

There are more docs that could be improved this way, if it suits you I could also make the changes to these docs :)

* ci: apply automated fixes

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-11-26 13:28:17 +01:00
Sarah
7783a7ae49
docs: add community resources page (#9831)
* add community resources page

* update link for blog posts

* update community resource links

* rm vue community section

* update old links

* fix community resource link
2025-11-06 12:59:56 +01:00
Damian Osipiuk
ec4214a5df
feat(vue-query-devtools): Embedded panel mode (#9790) 2025-10-21 15:01:30 +02:00
Damian Osipiuk
5cd86c6ef1
fix(query-persist-client-core): add option to change behavior of refetch after restore (#9745) 2025-10-10 23:04:23 +02:00
Lachlan Collins
89be1895e3
chore: update svelte examples and tests from runes PR 2025-09-26 22:51:17 +10:00
Dmytro Borysov
9a3f68373d
docs: Add not-prose class to browser logo images in devtools documentation (#9556) 2025-08-19 11:59:08 +02:00
Lee
2989e69dc0
docs(react-query): recommend defaultError = unknown instead of AxiosError (#9575)
* docs(react-query): recommend defaultError = unknown instead of AxiosError

Signed-off-by: leesb971204 <leesb971204@gmail.com>

* docs(react-query): clarify usage of defaultError in global Error type registration

Signed-off-by: leesb971204 <leesb971204@gmail.com>

* ci: apply automated fixes

* docs(solid-query): recommend defaultError = unknown instead of AxiosError

Signed-off-by: leesb971204 <leesb971204@gmail.com>

* docs(angular-query): recommend defaultError = unknown instead of AxiosError

Signed-off-by: leesb971204 <leesb971204@gmail.com>

* docs(vue-query): add example code for Registering a global Error

Signed-off-by: leesb971204 <leesb971204@gmail.com>

---------

Signed-off-by: leesb971204 <leesb971204@gmail.com>
Co-authored-by: Dominik Dorfmeister <office@dorfmeister.cc>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2025-08-18 17:46:32 +02:00
Dmytro Borysov
6402d756b7
chore: update browser icons (#9555) 2025-08-11 18:22:20 +02:00
Dmytro Borysov
d25c0da344
docs: Add Firefox and Edge browser extension support to devtools docs (#9548)
- Add browser logos for Chrome, Firefox, and Edge
- Update devtools documentation across all frameworks to include Firefox and Edge extensions
- Replace Chrome-only messaging with multi-browser support
- Add inline browser icons with links to respective extension stores
2025-08-11 13:08:47 +02:00
Lubos
763cee3e16
Add oRPC to community projects for TanStack Query (Vue) (#9539)
* Add oRPC to community projects for TanStack Query (Vue)

* Update oRPC link to TanStack Query integration

This should make oRPC more relevant when people search for things like "orpc tanstack query"

---------

Co-authored-by: Jonghyeon Ko <manudeli.ko@gmail.com>
2025-08-10 03:58:05 +09:00
Lubos
3a999ccd9f
Add Hey API to community projects for TanStack Query (Vue) (#9535)
* Add Hey API to community projects for TanStack Query (Vue)

* Update Hey API link to TanStack Query plugin

This should make Hey API more relevant when people search for things like "openapi tanstack query"

---------

Co-authored-by: Jonghyeon Ko <manudeli.ko@gmail.com>
2025-08-10 03:48:20 +09:00
Dominik Dorfmeister
1078bce264
refactor: deprecate createSyncStoragePersister (#9316) 2025-06-27 15:52:38 +02:00
Dmytro Borysov
1a0ab99943
docs: add Chrome extension information for TanStack Query devtools across multiple frameworks (#9275) 2025-06-19 20:51:01 +02:00