[pull] main from TanStack:main - #611
Merged
Merged
Conversation
…ter 'Version Packages' PR is squash-merged (#11279)
* docs: clarify contribution guidelines * ci: apply automated fixes --------- Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
… calls with 'query' (#11282)
…generated reference docs (#11204) * docs(preact-query): document functions and components with JSDoc for generated reference docs * docs(preact-query): replace concrete API calls with abstract fetcher names in JSDoc examples * docs(preact-query): rename mutation example fetcher to be CRUD-neutral * docs(preact-query): rename mutation example fetcher to 'createPosts' * docs(preact-query): add examples for Suspense, prefetch, and options-builder functions * docs(preact-query): add optimistic update, dependent query, and SSR hydration examples * docs(preact-query): add parameterized factory and mutationKey lookup examples to queryOptions/mutationOptions * docs(preact-query): add infiniteQueryOptions factory example and restore useMutationState's third example * docs(preact-query): add TkDodo-inspired multi-API reuse, initialData, and per-call mutate callback examples * docs(preact-query): document useIsRestoring, initialData, mutateAsync, and skipToken-excluded queryFn fields * docs(preact-query): fill in empty Returns sections for hooks and options builders * docs(preact-query): systematic sweep of generated pages for missing field descriptions and fix mismatched mutationOptions example * docs(preact-query): split mutationOptions' mutationKey overload into basic usage and lookup examples * docs(preact-query): fix overloads whose example didn't match their initialData-required type * docs(preact-query): fill overloads missing examples and useSuspenseQueries' queryClient param description * docs(preact-query): remove duplicated overload example and fix examples that failed type-checking * docs(preact-query): describe every documented parameter and restore reverted overload example * docs(preact-query): describe children props and low-level context exports * fix(preact-query): remove inaccurate 'queryFn is optional' claim from infiniteQueryOptions overload * docs(preact-query): add missing @returns to mutationOptions overloads and provider components * docs(preact-query): describe QueryErrorResetBoundary children and its render-function parameter * docs(preact-query): fix prose-accuracy issues found by multi-agent audit Corrects useQuery's first overload @returns to match its actual return type, moves the useSuspenseQuery/useSuspenseInfiniteQuery cancellation caveat out of the @returns block, softens overstated skipToken/queryFn claims, merges a duplicated useMutationState description, and adds missing JSDoc to QueryErrorResetBoundary's function-type aliases and UseMutateFunction/UseMutateAsyncFunction. * docs(preact-query): soften remaining overstated queryFn requirement in Suspense options * docs(preact-query): fix inaccurate prose in hydration, queryFn, and useQueries docs * docs(preact-query): correct hydration freshness gate, placeholderData arity, and deprecated 'fetchInfiniteQuery' reference * docs(preact-query): remove leftover 'data is never undefined' claim in 'useInfiniteQuery' overload docs * docs(preact-query): replace deprecated 'prefetchQuery'/'prefetchInfiniteQuery' calls in examples with 'query'/'infiniteQuery' * docs(preact-query): point 'usePrefetchQuery' JSDoc at 'queryClient.query' to match its actual option type
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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
See Commits and Changes for more details.
Created by
pull[bot] (v2.0.0-alpha.4)
Can you help keep this open source service alive? 💖 Please sponsor : )