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

606 commits

Author SHA1 Message Date
autofix-ci[bot]
73758917d1
ci: apply automated fixes 2026-11-01 12:51:26 +00:00
Lucas127128
e290639106
docs(svelte-query): Add guides (#12454)
* Add svelte guide

* fix issues in examples

* ci: apply automated fixes

---------

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-11-01 13:40:55 +01:00
autofix-ci[bot]
fbfe33829a
ci: apply automated fixes 2026-11-01 12:12:10 +00:00
Yeongbin Jeong
89d0a1f564
docs(react-query): document re-render behavior during polling (#12433)
* docs(react-query): document re-render behavior during polling

* ci: apply automated fixes

---------

Co-authored-by: Dominik Dorfmeister 🔮 <office@dorfmeister.cc>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-11-01 12:46:34 +01:00
Wonsuk Choi
14ac12ed63
docs(examples): add router and framework suffix to example directories to match their 'package.json' names (#12473)
* docs(examples): add router and framework suffix to example directories to match their 'package.json' names

* docs(svelte): update example links to the renamed 'basic-sveltekit' and 'ssr-sveltekit' directories
2026-11-01 19:39:04 +09:00
VGontier
8be136b022
fix(query-persist-client-core): discard malformed persisted queries (#11919)
* fix(query-persist-client-core): handle nullish persisted query state

* fix(query-persist-client-core): validate deserialized queries

* fix(query-persist-client-core): validate persisted query fields

* fix(query-persist-client-core): narrow persisted entry validation

---------

Co-authored-by: Vivien Gontier <vivien.gontier@paygreen.fr>
Co-authored-by: Ciarán Curley <ciaran.curley.11.11@gmail.com>
2026-10-31 15:43:35 +00:00
Wonsuk Choi
d88ba6ec46
docs(lit): remove '@tanstack/query-core' and 'lit' from the install commands to install only '@tanstack/lit-query' (#12209)
* docs(lit): remove '@tanstack/query-core' from the install commands since 'lit-query' already depends on it

* docs(lit): remove 'lit' from the install commands since apps using Lit Query already have it
2026-11-01 00:39:26 +09:00
Wonsuk Choi
979695d0a2
docs({react,preact,angular,solid,svelte,vue}-query): describe when the 'Defined' and 'Undefined' 'initialData' overloads are selected (#12460)
* docs({react,preact,angular,solid,svelte,vue}-query): describe the 'initialData' overloads as 'known to be defined' and 'omitted or may be undefined'

* docs({react,preact,angular,solid,svelte,vue}-query): regenerate reference docs

* docs({react,preact,angular,solid,svelte,vue}-query): mention an 'initialData' function that may return 'undefined' in the 'Undefined' overload descriptions

* docs({react,preact,angular,solid,svelte,vue}-query): regenerate reference docs
2026-10-30 16:41:25 +09:00
Wonsuk Choi
7ccba6e959
fix({react,preact,angular,solid,vue}-query/infiniteQueryOptions): correct the overload selected for a possibly-undefined 'initialData' (#11373)
* fix({react,preact,angular}-query): remove erroneous '| undefined' from 'DefinedInitialDataInfiniteOptions'

* test({react,preact,angular}-query/infiniteQueryOptions): use a non-literal condition for the ternary 'initialData' test

* fix({solid,vue}-query): accept a possibly-undefined 'initialData' in 'UndefinedInitialDataInfiniteOptions'

* fix(vue-query/infiniteQueryOptions): declare the 'Defined' overload first so a defined 'initialData' still selects it

* docs({react,preact,angular,solid,vue}-query): drop generated reference doc changes, regenerated by autofix after merge

* chore(.changeset): align the message with the PR title

* docs({react,preact,angular,solid,vue}-query/infiniteQueryOptions): describe overload selection by whether 'initialData' is known to be defined

* docs(framework/*/reference): regenerate reference docs

* docs(framework): restore the generated reference docs from main and leave them to autofix

* docs({react,preact,angular,solid,vue}-query): regenerate reference docs

* test({react,preact,angular,solid,vue}-query/infiniteQueryOptions): start test titles with 'should'
2026-10-30 10:06:32 +09:00
Wonsuk Choi
b9f369a23a
fix(solid-query/{queryOptions,useQuery}): correct the overload selected for 'initialData' (#11595)
* fix(solid-query/{queryOptions,useQuery}): correct the overload selected for 'initialData'

* ci: apply automated fixes

* docs(framework/*/reference): regenerate reference docs

* ci: apply automated fixes

* test(solid-query/queryOptions): assert the 'useQuery' data type when 'initialData' may be undefined

* docs(solid-query): regenerate reference docs

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-10-30 09:58:02 +09:00
Wonsuk Choi
2d5e6fcfc5
docs(solid): remove the leftover 'suspense' function and option mentions from the 'suspense' guide and quick start (#12427) 2026-10-28 11:05:13 +09:00
Wonsuk Choi
ab2a7198bb
docs(preact): add a streaming section to the SSR guide and an 'ssr-streaming' example (#12412) 2026-10-27 10:38:25 +09:00
autofix-ci[bot]
b74c5f61ef
ci: apply automated fixes 2026-10-26 10:19:26 +00:00
Wonsuk Choi
14cc3302e3
style(packages): write durations in 'count * unit * 1000' order (#12382)
* style(packages): write durations in 'count * unit * 1000' order

* docs(framework/*/reference): regenerate 'Query' reference for the 'isStaleByTime' example
2026-10-26 02:30:25 +09:00
Wonsuk Choi
650c69abcd
docs(framework): write snippet durations in 'count * unit * 1000' order (#12381) 2026-10-26 02:26:34 +09:00
Wonsuk Choi
bd816358c9
docs(framework): replace numeric separators with 'N * 1000' in snippet durations (#12380) 2026-10-26 02:19:46 +09:00
Wonsuk Choi
a29c34fd48
docs(framework/angular): use the defined 'QueriesService' in 'queryOptions' and 'mutationOptions' snippets (#12376) 2026-10-26 02:07:05 +09:00
Wonsuk Choi
eea41e497f
docs(framework/lit/guides): update example snippets to the 'services/{domain}' query factories (#12375) 2026-10-26 02:06:55 +09:00
Wonsuk Choi
db81416812
docs(*): use American spellings 'behavior', 'initialized', and 'optimize', and 'falsy' instead of 'falsey' (#12348) 2026-10-25 21:27:53 +09:00
Wonsuk Choi
6c3cc51cf6
docs(angular/devtools): add an 'Embedded Mode' section for 'injectDevtoolsPanel' (#12320) 2026-10-25 10:48:27 +09:00
Wonsuk Choi
a5d5e00458
docs(*-devtools): describe how the 'theme' prop interacts with the theme selected in the devtools Settings menu (#12314) 2026-10-24 02:53:19 +09:00
autofix-ci[bot]
4ed6095096
ci: apply automated fixes 2026-10-23 09:46:30 +00:00
Wonsuk Choi
90e331decc
docs(vue-query/queryClient): add the descriptions of the deprecated 'ensureQueryData', 'fetchQuery', 'prefetchQuery', 'fetchInfiniteQuery', and 'prefetchInfiniteQuery' overrides (#12212) 2026-10-20 21:55:40 +09:00
Wonsuk Choi
7b9a85e595
docs(vue-query/queryClient): inherit the descriptions of the first overload on the 'MaybeRefDeep' overloads of 'getQueryData', 'setQueryData', 'query', and 'infiniteQuery' (#12211) 2026-10-20 21:50:40 +09:00
Wonsuk Choi
9162d7f499
docs({angular,preact,solid,svelte,vue}/installation): state the supported framework versions to match the peer dependency ranges (#12210) 2026-10-20 20:52:25 +09:00
Wonsuk Choi
67eaf77279
docs(lit/guides/testing): add the testing guide with 'QueryClientProvider' and fake timers (#12206)
* docs(lit/guides/testing): add the testing guide with 'QueryClientProvider' and fake timers

* docs(lit/guides/testing): add the imports to the controller and fake timers examples so each can be used as its own file
2026-10-20 19:58:57 +09:00
Wonsuk Choi
bd427b90b2
docs(svelte/testing): add the imports to the 'withEffectRoot' and fake timers examples so each can be used as its own file (#12208) 2026-10-20 19:58:01 +09:00
Wonsuk Choi
56432b4a22
docs: use 'sh' instead of 'bash' for the shell code blocks (#12207) 2026-10-20 17:21:27 +09:00
Wonsuk Choi
4c56e9eea5
docs(svelte/testing): add the testing guide with '$effect.root' and Svelte Testing Library (#12205)
* docs(svelte/testing): add the testing guide with '$effect.root' and Svelte Testing Library

* docs(svelte/testing): clean up the effect root in 'finally' and add the 'withEffectRoot' helper variant

* docs(svelte/testing): explain that testing a function on its own needs a 'QueryClient' accessor and point to the component approach otherwise

* docs(svelte/testing): share the query with 'queryOptions' instead of a wrapper function that takes a 'QueryClient' accessor
2026-10-20 16:32:49 +09:00
Wonsuk Choi
21654f27bd
docs(react/guides/testing): install '@testing-library/react' instead of the React 17 hooks library and remove the dangling 'waitFor' notes (#12204) 2026-10-20 16:04:18 +09:00
Wonsuk Choi
35c505a5f2
docs(angular/guides/testing): limit the 'whenStable' guidance to work that settles right away and point to fake timers for the rest (#12203) 2026-10-20 15:47:24 +09:00
Wonsuk Choi
b5fe9512df
docs(angular): use 'angular-ts' for the code blocks with '@Component' to highlight their templates (#12202) 2026-10-20 15:30:50 +09:00
Wonsuk Choi
5178ad4b1a
docs(react/guides/testing): fix the 'nock' chain order and the 'data.pages' assertions in the infinite query example (#12200) 2026-10-20 15:26:34 +09:00
Wonsuk Choi
a8f39eea4c
docs(angular/guides/testing): advance fake timers in the mutation example instead of awaiting 'whenStable' (#12201) 2026-10-20 15:26:14 +09:00
Wonsuk Choi
fb53a81e1c
docs(angular/guides/testing): advance fake timers instead of awaiting 'whenStable' in the component examples, and add Angular Testing Library and 'TestBed.runInInjectionContext' variants (#12199)
* docs(angular/guides/testing): advance fake timers and run 'detectChanges' in the component examples with 'TestBed' and Angular Testing Library instead of awaiting 'whenStable'

* docs(angular/guides/testing): add the 'TestBed.runInInjectionContext' variant to the component examples
2026-10-20 15:17:59 +09:00
Wonsuk Choi
ca77c9f699
docs(solid/guides/testing): add the testing guide with 'renderHook' from '@solidjs/testing-library' (#12196)
* docs(solid/guides/testing): add the testing guide with 'renderHook' from '@solidjs/testing-library'

* docs(solid/guides/testing): restore real timers in 'afterEach' in the fake timers example
2026-10-20 14:50:47 +09:00
Wonsuk Choi
608fca7426
docs(angular/guides/testing): advance fake timers in the infinite query example instead of awaiting 'whenStable' (#12197)
* docs(angular/guides/testing): advance fake timers in the infinite query example instead of awaiting 'whenStable'

* docs(angular/guides/testing): restore real timers in 'afterEach' in the infinite query example
2026-10-20 14:50:24 +09:00
Wonsuk Choi
047d82914c
docs(vue/guides/testing): restore real timers in 'afterEach' in the fake timers example (#12198) 2026-10-20 14:50:10 +09:00
Wonsuk Choi
88b3edde75
docs(lit/guides/mutations): rename the third 'onError' parameter from 'context' to 'onMutateResult' (#12194) 2026-10-20 14:10:46 +09:00
Wonsuk Choi
85f00d8731
docs(lit/guides/ssr): move inline 'type' specifiers to top-level 'import type' declarations (#12193) 2026-10-20 14:10:31 +09:00
Wonsuk Choi
fab1bc22d6
docs(lit/guides/query-keys): declare 'userId' in 'static properties' so changing it refetches (#12192) 2026-10-20 14:10:04 +09:00
Wonsuk Choi
1d016ddab7
docs(lit/{installation,typescript}): require 'useDefineForClassFields: false' so reactive properties initialized as class fields trigger updates (#12191) 2026-10-20 14:09:41 +09:00
Wonsuk Choi
93ecb10912
docs(lit/guides/query-functions): add 'as const' to the 'queryKey' so the destructured filters are typed (#12190) 2026-10-20 14:09:27 +09:00
Wonsuk Choi
4ea78d6bb2
docs(angular/overview): guard the error with 'isError()', rename the 'Response' interface to 'Repo', and remove the unused 'CommonModule' import (#12183) 2026-10-20 12:04:29 +09:00
Wonsuk Choi
86a9c88b38
docs(angular/guides/mutation-options): fix the duplicated 'query-options' id and inject the 'QueryClient' used in the example (#12182) 2026-10-20 12:04:14 +09:00
Wonsuk Choi
c223661efb
docs(angular/guides/testing): use 'provideHttpClientTesting' instead of the deprecated 'HttpClientTestingModule' and add 'initialPageParam' to the infinite query example (#12181) 2026-10-20 12:01:12 +09:00
Wonsuk Choi
4a18a7016e
docs(angular/guides/infinite-queries): add the required 'initialPageParam' to the bi-directional example (#12180) 2026-10-20 12:00:44 +09:00
Wonsuk Choi
ef39130852
docs(angular/guides/query-cancellation): pass filters to 'cancelQueries' and fix the imports of the 'HttpClient' example (#12179) 2026-10-20 12:00:25 +09:00
Wonsuk Choi
13d1f1c01f
docs(angular/quick-start): provide 'HttpClient' in the NgModule example (#12178) 2026-10-20 12:00:10 +09:00
Wonsuk Choi
315e8fbf18
docs(vue/reactivity): fix the garbled sentence about intentionally non-reactive queries (#12159) 2026-10-20 03:55:52 +09:00