* 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
* 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
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>
* 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>
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
* 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
* 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>
* 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>
* 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>
* 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>
* add community resources page
* update link for blog posts
* update community resource links
* rm vue community section
* update old links
* fix community resource link
- 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
* 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>
* 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>