0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/preact/reference/functions/useQuery.md

379 lines
9.9 KiB

feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): improve JSDoc examples across hooks and options factories (#11301) * docs(preact-query): wrap 'useIsFetching' example in a component * docs(preact-query): wrap 'useQueries' examples in components and add 'isError' handling * docs(preact-query): wrap 'useIsMutating' and 'useMutationState' examples in components * docs(preact-query): wrap 'queryOptions' examples in components * docs(preact-query): wrap 'infiniteQueryOptions' example in a component * fix(preact-query): correctly distinguish error state from loading in 'infiniteQueryOptions' example * fix(preact-query): correct mutation terminology and filter by success status in 'useMutationState' examples * docs(preact-query): destructure useInfiniteQuery result in 'infiniteQueryOptions' example * docs(preact-query): rename 'variables' to 'pendingVariables' in 'useMutationState' example * docs(preact-query): rename 'data' to 'savedPosts' in 'useMutationState' examples * docs(preact-query): rename 'results'/'result' to 'addResults'/'addResult' in 'useMutation' Promise.allSettled example * docs(preact-query): rename 'latest' to 'latestSavedPost' in 'useMutationState' example * docs(preact-query): render fetched pages and handle loading/error states in 'useInfiniteQuery' examples * docs(preact-query): render infinite query lists as '<ul>'/'<li>' instead of flat '<p>' tags * docs(preact-query): show hover-triggered prefetch instead of an unlocated 'Elsewhere' comment in 'queryOptions'/'infiniteQueryOptions' examples * docs(preact-query): move hover-prefetch examples from 'queryOptions'/'infiniteQueryOptions' to 'useQuery'/'useInfiniteQuery' * docs(preact-query): render list examples as '<ul>'/'<li>' and fix undefined refs across remaining hooks * docs(preact-query): name the prefetch id in 'queryOptions'/'infiniteQueryOptions' examples instead of an unexplained literal * docs(preact-query): add 'skipToken' examples for type-safe conditional disabling * docs(preact-query): use 'isLoading' with optional chaining in the infinite-query 'skipToken' examples * docs(preact-query): add missing 'isPending'/'isError' handling across 'queryOptions'/'useQuery'/'infiniteQueryOptions'/'useInfiniteQuery' examples * docs(preact-query): keep 'initialData' examples showing data alongside errors instead of hiding it * docs(preact-query): use scroll-triggered pagination in 'useInfiniteQuery' examples, add a 'fetchNextPage' trigger to 'infiniteQueryOptions' * docs(preact-query): guard scroll-triggered 'fetchNextPage' with 'isFetching', move cross-reference out of '@example' * docs(preact-query): move duplicated usage examples from 'queryOptions'/'infiniteQueryOptions' into their hooks * docs(preact-query): remove duplicated basic-mutation example from 'mutationOptions', trim boilerplate '@remarks' * docs(preact-query): add 'combine' example to 'useSuspenseQueries', link 'useSuspenseInfiniteQuery' to 'useInfiniteQuery' and document its waterfall/refetch risks * docs(preact-query): drop irrelevant 'useSuspenseQueries' reference from 'useSuspenseInfiniteQuery' waterfall remark * docs(preact-query): strengthen 'useMutation''s '@see' pointer to 'mutationOptions' with its 'mutationKey' lookup benefit * docs(preact-query): add blank lines around 'isPending'/'isError' guards for consistency with other examples
2026-08-30 13:15:47 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): improve JSDoc examples across hooks and options factories (#11301) * docs(preact-query): wrap 'useIsFetching' example in a component * docs(preact-query): wrap 'useQueries' examples in components and add 'isError' handling * docs(preact-query): wrap 'useIsMutating' and 'useMutationState' examples in components * docs(preact-query): wrap 'queryOptions' examples in components * docs(preact-query): wrap 'infiniteQueryOptions' example in a component * fix(preact-query): correctly distinguish error state from loading in 'infiniteQueryOptions' example * fix(preact-query): correct mutation terminology and filter by success status in 'useMutationState' examples * docs(preact-query): destructure useInfiniteQuery result in 'infiniteQueryOptions' example * docs(preact-query): rename 'variables' to 'pendingVariables' in 'useMutationState' example * docs(preact-query): rename 'data' to 'savedPosts' in 'useMutationState' examples * docs(preact-query): rename 'results'/'result' to 'addResults'/'addResult' in 'useMutation' Promise.allSettled example * docs(preact-query): rename 'latest' to 'latestSavedPost' in 'useMutationState' example * docs(preact-query): render fetched pages and handle loading/error states in 'useInfiniteQuery' examples * docs(preact-query): render infinite query lists as '<ul>'/'<li>' instead of flat '<p>' tags * docs(preact-query): show hover-triggered prefetch instead of an unlocated 'Elsewhere' comment in 'queryOptions'/'infiniteQueryOptions' examples * docs(preact-query): move hover-prefetch examples from 'queryOptions'/'infiniteQueryOptions' to 'useQuery'/'useInfiniteQuery' * docs(preact-query): render list examples as '<ul>'/'<li>' and fix undefined refs across remaining hooks * docs(preact-query): name the prefetch id in 'queryOptions'/'infiniteQueryOptions' examples instead of an unexplained literal * docs(preact-query): add 'skipToken' examples for type-safe conditional disabling * docs(preact-query): use 'isLoading' with optional chaining in the infinite-query 'skipToken' examples * docs(preact-query): add missing 'isPending'/'isError' handling across 'queryOptions'/'useQuery'/'infiniteQueryOptions'/'useInfiniteQuery' examples * docs(preact-query): keep 'initialData' examples showing data alongside errors instead of hiding it * docs(preact-query): use scroll-triggered pagination in 'useInfiniteQuery' examples, add a 'fetchNextPage' trigger to 'infiniteQueryOptions' * docs(preact-query): guard scroll-triggered 'fetchNextPage' with 'isFetching', move cross-reference out of '@example' * docs(preact-query): move duplicated usage examples from 'queryOptions'/'infiniteQueryOptions' into their hooks * docs(preact-query): remove duplicated basic-mutation example from 'mutationOptions', trim boilerplate '@remarks' * docs(preact-query): add 'combine' example to 'useSuspenseQueries', link 'useSuspenseInfiniteQuery' to 'useInfiniteQuery' and document its waterfall/refetch risks * docs(preact-query): drop irrelevant 'useSuspenseQueries' reference from 'useSuspenseInfiniteQuery' waterfall remark * docs(preact-query): strengthen 'useMutation''s '@see' pointer to 'mutationOptions' with its 'mutationKey' lookup benefit * docs(preact-query): add blank lines around 'isPending'/'isError' guards for consistency with other examples
2026-08-30 13:15:47 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): improve JSDoc examples across hooks and options factories (#11301) * docs(preact-query): wrap 'useIsFetching' example in a component * docs(preact-query): wrap 'useQueries' examples in components and add 'isError' handling * docs(preact-query): wrap 'useIsMutating' and 'useMutationState' examples in components * docs(preact-query): wrap 'queryOptions' examples in components * docs(preact-query): wrap 'infiniteQueryOptions' example in a component * fix(preact-query): correctly distinguish error state from loading in 'infiniteQueryOptions' example * fix(preact-query): correct mutation terminology and filter by success status in 'useMutationState' examples * docs(preact-query): destructure useInfiniteQuery result in 'infiniteQueryOptions' example * docs(preact-query): rename 'variables' to 'pendingVariables' in 'useMutationState' example * docs(preact-query): rename 'data' to 'savedPosts' in 'useMutationState' examples * docs(preact-query): rename 'results'/'result' to 'addResults'/'addResult' in 'useMutation' Promise.allSettled example * docs(preact-query): rename 'latest' to 'latestSavedPost' in 'useMutationState' example * docs(preact-query): render fetched pages and handle loading/error states in 'useInfiniteQuery' examples * docs(preact-query): render infinite query lists as '<ul>'/'<li>' instead of flat '<p>' tags * docs(preact-query): show hover-triggered prefetch instead of an unlocated 'Elsewhere' comment in 'queryOptions'/'infiniteQueryOptions' examples * docs(preact-query): move hover-prefetch examples from 'queryOptions'/'infiniteQueryOptions' to 'useQuery'/'useInfiniteQuery' * docs(preact-query): render list examples as '<ul>'/'<li>' and fix undefined refs across remaining hooks * docs(preact-query): name the prefetch id in 'queryOptions'/'infiniteQueryOptions' examples instead of an unexplained literal * docs(preact-query): add 'skipToken' examples for type-safe conditional disabling * docs(preact-query): use 'isLoading' with optional chaining in the infinite-query 'skipToken' examples * docs(preact-query): add missing 'isPending'/'isError' handling across 'queryOptions'/'useQuery'/'infiniteQueryOptions'/'useInfiniteQuery' examples * docs(preact-query): keep 'initialData' examples showing data alongside errors instead of hiding it * docs(preact-query): use scroll-triggered pagination in 'useInfiniteQuery' examples, add a 'fetchNextPage' trigger to 'infiniteQueryOptions' * docs(preact-query): guard scroll-triggered 'fetchNextPage' with 'isFetching', move cross-reference out of '@example' * docs(preact-query): move duplicated usage examples from 'queryOptions'/'infiniteQueryOptions' into their hooks * docs(preact-query): remove duplicated basic-mutation example from 'mutationOptions', trim boilerplate '@remarks' * docs(preact-query): add 'combine' example to 'useSuspenseQueries', link 'useSuspenseInfiniteQuery' to 'useInfiniteQuery' and document its waterfall/refetch risks * docs(preact-query): drop irrelevant 'useSuspenseQueries' reference from 'useSuspenseInfiniteQuery' waterfall remark * docs(preact-query): strengthen 'useMutation''s '@see' pointer to 'mutationOptions' with its 'mutationKey' lookup benefit * docs(preact-query): add blank lines around 'isPending'/'isError' guards for consistency with other examples
2026-08-30 13:15:47 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): improve JSDoc examples across hooks and options factories (#11301) * docs(preact-query): wrap 'useIsFetching' example in a component * docs(preact-query): wrap 'useQueries' examples in components and add 'isError' handling * docs(preact-query): wrap 'useIsMutating' and 'useMutationState' examples in components * docs(preact-query): wrap 'queryOptions' examples in components * docs(preact-query): wrap 'infiniteQueryOptions' example in a component * fix(preact-query): correctly distinguish error state from loading in 'infiniteQueryOptions' example * fix(preact-query): correct mutation terminology and filter by success status in 'useMutationState' examples * docs(preact-query): destructure useInfiniteQuery result in 'infiniteQueryOptions' example * docs(preact-query): rename 'variables' to 'pendingVariables' in 'useMutationState' example * docs(preact-query): rename 'data' to 'savedPosts' in 'useMutationState' examples * docs(preact-query): rename 'results'/'result' to 'addResults'/'addResult' in 'useMutation' Promise.allSettled example * docs(preact-query): rename 'latest' to 'latestSavedPost' in 'useMutationState' example * docs(preact-query): render fetched pages and handle loading/error states in 'useInfiniteQuery' examples * docs(preact-query): render infinite query lists as '<ul>'/'<li>' instead of flat '<p>' tags * docs(preact-query): show hover-triggered prefetch instead of an unlocated 'Elsewhere' comment in 'queryOptions'/'infiniteQueryOptions' examples * docs(preact-query): move hover-prefetch examples from 'queryOptions'/'infiniteQueryOptions' to 'useQuery'/'useInfiniteQuery' * docs(preact-query): render list examples as '<ul>'/'<li>' and fix undefined refs across remaining hooks * docs(preact-query): name the prefetch id in 'queryOptions'/'infiniteQueryOptions' examples instead of an unexplained literal * docs(preact-query): add 'skipToken' examples for type-safe conditional disabling * docs(preact-query): use 'isLoading' with optional chaining in the infinite-query 'skipToken' examples * docs(preact-query): add missing 'isPending'/'isError' handling across 'queryOptions'/'useQuery'/'infiniteQueryOptions'/'useInfiniteQuery' examples * docs(preact-query): keep 'initialData' examples showing data alongside errors instead of hiding it * docs(preact-query): use scroll-triggered pagination in 'useInfiniteQuery' examples, add a 'fetchNextPage' trigger to 'infiniteQueryOptions' * docs(preact-query): guard scroll-triggered 'fetchNextPage' with 'isFetching', move cross-reference out of '@example' * docs(preact-query): move duplicated usage examples from 'queryOptions'/'infiniteQueryOptions' into their hooks * docs(preact-query): remove duplicated basic-mutation example from 'mutationOptions', trim boilerplate '@remarks' * docs(preact-query): add 'combine' example to 'useSuspenseQueries', link 'useSuspenseInfiniteQuery' to 'useInfiniteQuery' and document its waterfall/refetch risks * docs(preact-query): drop irrelevant 'useSuspenseQueries' reference from 'useSuspenseInfiniteQuery' waterfall remark * docs(preact-query): strengthen 'useMutation''s '@see' pointer to 'mutationOptions' with its 'mutationKey' lookup benefit * docs(preact-query): add blank lines around 'isPending'/'isError' guards for consistency with other examples
2026-08-30 13:15:47 +09:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
feat: Preact Adapter (#9935) * initial setup -- duplicated + package.json edited * simple preact updations * missed a React.ReactNode * testing grunt work (preact library + other small issues + ErrorBoundary custom implementation) * missed a few * Adds ErrorBoundary (from react-error-boundary, but scaled down for preact) -- fixes a lot of tests, which expect react-related functionality * useSuspenseQueries left -- removed the useQuery.promise tests * forgot the console logs * useSuspenseQueries 2 resolved; tests done * ci: apply automated fixes * fix: example * fix: configs should be symlinks * fix: sync versions for npm-run-all2 * ref: re-sync runall2 * ref: go back to 5.0.0 * ref: remove changelog * react-query -> preact-query * remove use client directive + added the useSyncExternalStore (decoupled from compat) * remove the react remnants * generate docs * typescript eslint * docs * vite config fix * docs now reference react docs (most of them atleast) * code-rabbit issues addressed * <div/> lol * fix: docs * ci: apply automated fixes * fix: lockfile * fix: duplicated versions * lockfile (I cooked or am I cooked) * ci: apply automated fixes * Making small edits to fix versioning, warnings, and lock * unhandled error compat * Fixing CI * Fixed the CI errors * ci: apply automated fixes * Prettier format * Update changeset for Preact Adapter feature --------- Co-authored-by: TkDodo <office@dorfmeister.cc> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
2026-02-10 05:02:20 -06:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): improve JSDoc examples across hooks and options factories (#11301) * docs(preact-query): wrap 'useIsFetching' example in a component * docs(preact-query): wrap 'useQueries' examples in components and add 'isError' handling * docs(preact-query): wrap 'useIsMutating' and 'useMutationState' examples in components * docs(preact-query): wrap 'queryOptions' examples in components * docs(preact-query): wrap 'infiniteQueryOptions' example in a component * fix(preact-query): correctly distinguish error state from loading in 'infiniteQueryOptions' example * fix(preact-query): correct mutation terminology and filter by success status in 'useMutationState' examples * docs(preact-query): destructure useInfiniteQuery result in 'infiniteQueryOptions' example * docs(preact-query): rename 'variables' to 'pendingVariables' in 'useMutationState' example * docs(preact-query): rename 'data' to 'savedPosts' in 'useMutationState' examples * docs(preact-query): rename 'results'/'result' to 'addResults'/'addResult' in 'useMutation' Promise.allSettled example * docs(preact-query): rename 'latest' to 'latestSavedPost' in 'useMutationState' example * docs(preact-query): render fetched pages and handle loading/error states in 'useInfiniteQuery' examples * docs(preact-query): render infinite query lists as '<ul>'/'<li>' instead of flat '<p>' tags * docs(preact-query): show hover-triggered prefetch instead of an unlocated 'Elsewhere' comment in 'queryOptions'/'infiniteQueryOptions' examples * docs(preact-query): move hover-prefetch examples from 'queryOptions'/'infiniteQueryOptions' to 'useQuery'/'useInfiniteQuery' * docs(preact-query): render list examples as '<ul>'/'<li>' and fix undefined refs across remaining hooks * docs(preact-query): name the prefetch id in 'queryOptions'/'infiniteQueryOptions' examples instead of an unexplained literal * docs(preact-query): add 'skipToken' examples for type-safe conditional disabling * docs(preact-query): use 'isLoading' with optional chaining in the infinite-query 'skipToken' examples * docs(preact-query): add missing 'isPending'/'isError' handling across 'queryOptions'/'useQuery'/'infiniteQueryOptions'/'useInfiniteQuery' examples * docs(preact-query): keep 'initialData' examples showing data alongside errors instead of hiding it * docs(preact-query): use scroll-triggered pagination in 'useInfiniteQuery' examples, add a 'fetchNextPage' trigger to 'infiniteQueryOptions' * docs(preact-query): guard scroll-triggered 'fetchNextPage' with 'isFetching', move cross-reference out of '@example' * docs(preact-query): move duplicated usage examples from 'queryOptions'/'infiniteQueryOptions' into their hooks * docs(preact-query): remove duplicated basic-mutation example from 'mutationOptions', trim boilerplate '@remarks' * docs(preact-query): add 'combine' example to 'useSuspenseQueries', link 'useSuspenseInfiniteQuery' to 'useInfiniteQuery' and document its waterfall/refetch risks * docs(preact-query): drop irrelevant 'useSuspenseQueries' reference from 'useSuspenseInfiniteQuery' waterfall remark * docs(preact-query): strengthen 'useMutation''s '@see' pointer to 'mutationOptions' with its 'mutationKey' lookup benefit * docs(preact-query): add blank lines around 'isPending'/'isError' guards for consistency with other examples
2026-08-30 13:15:47 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): improve JSDoc examples across hooks and options factories (#11301) * docs(preact-query): wrap 'useIsFetching' example in a component * docs(preact-query): wrap 'useQueries' examples in components and add 'isError' handling * docs(preact-query): wrap 'useIsMutating' and 'useMutationState' examples in components * docs(preact-query): wrap 'queryOptions' examples in components * docs(preact-query): wrap 'infiniteQueryOptions' example in a component * fix(preact-query): correctly distinguish error state from loading in 'infiniteQueryOptions' example * fix(preact-query): correct mutation terminology and filter by success status in 'useMutationState' examples * docs(preact-query): destructure useInfiniteQuery result in 'infiniteQueryOptions' example * docs(preact-query): rename 'variables' to 'pendingVariables' in 'useMutationState' example * docs(preact-query): rename 'data' to 'savedPosts' in 'useMutationState' examples * docs(preact-query): rename 'results'/'result' to 'addResults'/'addResult' in 'useMutation' Promise.allSettled example * docs(preact-query): rename 'latest' to 'latestSavedPost' in 'useMutationState' example * docs(preact-query): render fetched pages and handle loading/error states in 'useInfiniteQuery' examples * docs(preact-query): render infinite query lists as '<ul>'/'<li>' instead of flat '<p>' tags * docs(preact-query): show hover-triggered prefetch instead of an unlocated 'Elsewhere' comment in 'queryOptions'/'infiniteQueryOptions' examples * docs(preact-query): move hover-prefetch examples from 'queryOptions'/'infiniteQueryOptions' to 'useQuery'/'useInfiniteQuery' * docs(preact-query): render list examples as '<ul>'/'<li>' and fix undefined refs across remaining hooks * docs(preact-query): name the prefetch id in 'queryOptions'/'infiniteQueryOptions' examples instead of an unexplained literal * docs(preact-query): add 'skipToken' examples for type-safe conditional disabling * docs(preact-query): use 'isLoading' with optional chaining in the infinite-query 'skipToken' examples * docs(preact-query): add missing 'isPending'/'isError' handling across 'queryOptions'/'useQuery'/'infiniteQueryOptions'/'useInfiniteQuery' examples * docs(preact-query): keep 'initialData' examples showing data alongside errors instead of hiding it * docs(preact-query): use scroll-triggered pagination in 'useInfiniteQuery' examples, add a 'fetchNextPage' trigger to 'infiniteQueryOptions' * docs(preact-query): guard scroll-triggered 'fetchNextPage' with 'isFetching', move cross-reference out of '@example' * docs(preact-query): move duplicated usage examples from 'queryOptions'/'infiniteQueryOptions' into their hooks * docs(preact-query): remove duplicated basic-mutation example from 'mutationOptions', trim boilerplate '@remarks' * docs(preact-query): add 'combine' example to 'useSuspenseQueries', link 'useSuspenseInfiniteQuery' to 'useInfiniteQuery' and document its waterfall/refetch risks * docs(preact-query): drop irrelevant 'useSuspenseQueries' reference from 'useSuspenseInfiniteQuery' waterfall remark * docs(preact-query): strengthen 'useMutation''s '@see' pointer to 'mutationOptions' with its 'mutationKey' lookup benefit * docs(preact-query): add blank lines around 'isPending'/'isError' guards for consistency with other examples
2026-08-30 13:15:47 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): improve JSDoc examples across hooks and options factories (#11301) * docs(preact-query): wrap 'useIsFetching' example in a component * docs(preact-query): wrap 'useQueries' examples in components and add 'isError' handling * docs(preact-query): wrap 'useIsMutating' and 'useMutationState' examples in components * docs(preact-query): wrap 'queryOptions' examples in components * docs(preact-query): wrap 'infiniteQueryOptions' example in a component * fix(preact-query): correctly distinguish error state from loading in 'infiniteQueryOptions' example * fix(preact-query): correct mutation terminology and filter by success status in 'useMutationState' examples * docs(preact-query): destructure useInfiniteQuery result in 'infiniteQueryOptions' example * docs(preact-query): rename 'variables' to 'pendingVariables' in 'useMutationState' example * docs(preact-query): rename 'data' to 'savedPosts' in 'useMutationState' examples * docs(preact-query): rename 'results'/'result' to 'addResults'/'addResult' in 'useMutation' Promise.allSettled example * docs(preact-query): rename 'latest' to 'latestSavedPost' in 'useMutationState' example * docs(preact-query): render fetched pages and handle loading/error states in 'useInfiniteQuery' examples * docs(preact-query): render infinite query lists as '<ul>'/'<li>' instead of flat '<p>' tags * docs(preact-query): show hover-triggered prefetch instead of an unlocated 'Elsewhere' comment in 'queryOptions'/'infiniteQueryOptions' examples * docs(preact-query): move hover-prefetch examples from 'queryOptions'/'infiniteQueryOptions' to 'useQuery'/'useInfiniteQuery' * docs(preact-query): render list examples as '<ul>'/'<li>' and fix undefined refs across remaining hooks * docs(preact-query): name the prefetch id in 'queryOptions'/'infiniteQueryOptions' examples instead of an unexplained literal * docs(preact-query): add 'skipToken' examples for type-safe conditional disabling * docs(preact-query): use 'isLoading' with optional chaining in the infinite-query 'skipToken' examples * docs(preact-query): add missing 'isPending'/'isError' handling across 'queryOptions'/'useQuery'/'infiniteQueryOptions'/'useInfiniteQuery' examples * docs(preact-query): keep 'initialData' examples showing data alongside errors instead of hiding it * docs(preact-query): use scroll-triggered pagination in 'useInfiniteQuery' examples, add a 'fetchNextPage' trigger to 'infiniteQueryOptions' * docs(preact-query): guard scroll-triggered 'fetchNextPage' with 'isFetching', move cross-reference out of '@example' * docs(preact-query): move duplicated usage examples from 'queryOptions'/'infiniteQueryOptions' into their hooks * docs(preact-query): remove duplicated basic-mutation example from 'mutationOptions', trim boilerplate '@remarks' * docs(preact-query): add 'combine' example to 'useSuspenseQueries', link 'useSuspenseInfiniteQuery' to 'useInfiniteQuery' and document its waterfall/refetch risks * docs(preact-query): drop irrelevant 'useSuspenseQueries' reference from 'useSuspenseInfiniteQuery' waterfall remark * docs(preact-query): strengthen 'useMutation''s '@see' pointer to 'mutationOptions' with its 'mutationKey' lookup benefit * docs(preact-query): add blank lines around 'isPending'/'isError' guards for consistency with other examples
2026-08-30 13:15:47 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): improve JSDoc examples across hooks and options factories (#11301) * docs(preact-query): wrap 'useIsFetching' example in a component * docs(preact-query): wrap 'useQueries' examples in components and add 'isError' handling * docs(preact-query): wrap 'useIsMutating' and 'useMutationState' examples in components * docs(preact-query): wrap 'queryOptions' examples in components * docs(preact-query): wrap 'infiniteQueryOptions' example in a component * fix(preact-query): correctly distinguish error state from loading in 'infiniteQueryOptions' example * fix(preact-query): correct mutation terminology and filter by success status in 'useMutationState' examples * docs(preact-query): destructure useInfiniteQuery result in 'infiniteQueryOptions' example * docs(preact-query): rename 'variables' to 'pendingVariables' in 'useMutationState' example * docs(preact-query): rename 'data' to 'savedPosts' in 'useMutationState' examples * docs(preact-query): rename 'results'/'result' to 'addResults'/'addResult' in 'useMutation' Promise.allSettled example * docs(preact-query): rename 'latest' to 'latestSavedPost' in 'useMutationState' example * docs(preact-query): render fetched pages and handle loading/error states in 'useInfiniteQuery' examples * docs(preact-query): render infinite query lists as '<ul>'/'<li>' instead of flat '<p>' tags * docs(preact-query): show hover-triggered prefetch instead of an unlocated 'Elsewhere' comment in 'queryOptions'/'infiniteQueryOptions' examples * docs(preact-query): move hover-prefetch examples from 'queryOptions'/'infiniteQueryOptions' to 'useQuery'/'useInfiniteQuery' * docs(preact-query): render list examples as '<ul>'/'<li>' and fix undefined refs across remaining hooks * docs(preact-query): name the prefetch id in 'queryOptions'/'infiniteQueryOptions' examples instead of an unexplained literal * docs(preact-query): add 'skipToken' examples for type-safe conditional disabling * docs(preact-query): use 'isLoading' with optional chaining in the infinite-query 'skipToken' examples * docs(preact-query): add missing 'isPending'/'isError' handling across 'queryOptions'/'useQuery'/'infiniteQueryOptions'/'useInfiniteQuery' examples * docs(preact-query): keep 'initialData' examples showing data alongside errors instead of hiding it * docs(preact-query): use scroll-triggered pagination in 'useInfiniteQuery' examples, add a 'fetchNextPage' trigger to 'infiniteQueryOptions' * docs(preact-query): guard scroll-triggered 'fetchNextPage' with 'isFetching', move cross-reference out of '@example' * docs(preact-query): move duplicated usage examples from 'queryOptions'/'infiniteQueryOptions' into their hooks * docs(preact-query): remove duplicated basic-mutation example from 'mutationOptions', trim boilerplate '@remarks' * docs(preact-query): add 'combine' example to 'useSuspenseQueries', link 'useSuspenseInfiniteQuery' to 'useInfiniteQuery' and document its waterfall/refetch risks * docs(preact-query): drop irrelevant 'useSuspenseQueries' reference from 'useSuspenseInfiniteQuery' waterfall remark * docs(preact-query): strengthen 'useMutation''s '@see' pointer to 'mutationOptions' with its 'mutationKey' lookup benefit * docs(preact-query): add blank lines around 'isPending'/'isError' guards for consistency with other examples
2026-08-30 13:15:47 +09:00
docs(preact-query): document functions and components with JSDoc for 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
2026-08-25 16:43:01 +09:00
docs(preact-query): improve JSDoc examples across hooks and options factories (#11301) * docs(preact-query): wrap 'useIsFetching' example in a component * docs(preact-query): wrap 'useQueries' examples in components and add 'isError' handling * docs(preact-query): wrap 'useIsMutating' and 'useMutationState' examples in components * docs(preact-query): wrap 'queryOptions' examples in components * docs(preact-query): wrap 'infiniteQueryOptions' example in a component * fix(preact-query): correctly distinguish error state from loading in 'infiniteQueryOptions' example * fix(preact-query): correct mutation terminology and filter by success status in 'useMutationState' examples * docs(preact-query): destructure useInfiniteQuery result in 'infiniteQueryOptions' example * docs(preact-query): rename 'variables' to 'pendingVariables' in 'useMutationState' example * docs(preact-query): rename 'data' to 'savedPosts' in 'useMutationState' examples * docs(preact-query): rename 'results'/'result' to 'addResults'/'addResult' in 'useMutation' Promise.allSettled example * docs(preact-query): rename 'latest' to 'latestSavedPost' in 'useMutationState' example * docs(preact-query): render fetched pages and handle loading/error states in 'useInfiniteQuery' examples * docs(preact-query): render infinite query lists as '<ul>'/'<li>' instead of flat '<p>' tags * docs(preact-query): show hover-triggered prefetch instead of an unlocated 'Elsewhere' comment in 'queryOptions'/'infiniteQueryOptions' examples * docs(preact-query): move hover-prefetch examples from 'queryOptions'/'infiniteQueryOptions' to 'useQuery'/'useInfiniteQuery' * docs(preact-query): render list examples as '<ul>'/'<li>' and fix undefined refs across remaining hooks * docs(preact-query): name the prefetch id in 'queryOptions'/'infiniteQueryOptions' examples instead of an unexplained literal * docs(preact-query): add 'skipToken' examples for type-safe conditional disabling * docs(preact-query): use 'isLoading' with optional chaining in the infinite-query 'skipToken' examples * docs(preact-query): add missing 'isPending'/'isError' handling across 'queryOptions'/'useQuery'/'infiniteQueryOptions'/'useInfiniteQuery' examples * docs(preact-query): keep 'initialData' examples showing data alongside errors instead of hiding it * docs(preact-query): use scroll-triggered pagination in 'useInfiniteQuery' examples, add a 'fetchNextPage' trigger to 'infiniteQueryOptions' * docs(preact-query): guard scroll-triggered 'fetchNextPage' with 'isFetching', move cross-reference out of '@example' * docs(preact-query): move duplicated usage examples from 'queryOptions'/'infiniteQueryOptions' into their hooks * docs(preact-query): remove duplicated basic-mutation example from 'mutationOptions', trim boilerplate '@remarks' * docs(preact-query): add 'combine' example to 'useSuspenseQueries', link 'useSuspenseInfiniteQuery' to 'useInfiniteQuery' and document its waterfall/refetch risks * docs(preact-query): drop irrelevant 'useSuspenseQueries' reference from 'useSuspenseInfiniteQuery' waterfall remark * docs(preact-query): strengthen 'useMutation''s '@see' pointer to 'mutationOptions' with its 'mutationKey' lookup benefit * docs(preact-query): add blank lines around 'isPending'/'isError' guards for consistency with other examples
2026-08-30 13:15:47 +09:00
docs(preact-query): improve JSDoc examples across hooks and options factories (#11301) * docs(preact-query): wrap 'useIsFetching' example in a component * docs(preact-query): wrap 'useQueries' examples in components and add 'isError' handling * docs(preact-query): wrap 'useIsMutating' and 'useMutationState' examples in components * docs(preact-query): wrap 'queryOptions' examples in components * docs(preact-query): wrap 'infiniteQueryOptions' example in a component * fix(preact-query): correctly distinguish error state from loading in 'infiniteQueryOptions' example * fix(preact-query): correct mutation terminology and filter by success status in 'useMutationState' examples * docs(preact-query): destructure useInfiniteQuery result in 'infiniteQueryOptions' example * docs(preact-query): rename 'variables' to 'pendingVariables' in 'useMutationState' example * docs(preact-query): rename 'data' to 'savedPosts' in 'useMutationState' examples * docs(preact-query): rename 'results'/'result' to 'addResults'/'addResult' in 'useMutation' Promise.allSettled example * docs(preact-query): rename 'latest' to 'latestSavedPost' in 'useMutationState' example * docs(preact-query): render fetched pages and handle loading/error states in 'useInfiniteQuery' examples * docs(preact-query): render infinite query lists as '<ul>'/'<li>' instead of flat '<p>' tags * docs(preact-query): show hover-triggered prefetch instead of an unlocated 'Elsewhere' comment in 'queryOptions'/'infiniteQueryOptions' examples * docs(preact-query): move hover-prefetch examples from 'queryOptions'/'infiniteQueryOptions' to 'useQuery'/'useInfiniteQuery' * docs(preact-query): render list examples as '<ul>'/'<li>' and fix undefined refs across remaining hooks * docs(preact-query): name the prefetch id in 'queryOptions'/'infiniteQueryOptions' examples instead of an unexplained literal * docs(preact-query): add 'skipToken' examples for type-safe conditional disabling * docs(preact-query): use 'isLoading' with optional chaining in the infinite-query 'skipToken' examples * docs(preact-query): add missing 'isPending'/'isError' handling across 'queryOptions'/'useQuery'/'infiniteQueryOptions'/'useInfiniteQuery' examples * docs(preact-query): keep 'initialData' examples showing data alongside errors instead of hiding it * docs(preact-query): use scroll-triggered pagination in 'useInfiniteQuery' examples, add a 'fetchNextPage' trigger to 'infiniteQueryOptions' * docs(preact-query): guard scroll-triggered 'fetchNextPage' with 'isFetching', move cross-reference out of '@example' * docs(preact-query): move duplicated usage examples from 'queryOptions'/'infiniteQueryOptions' into their hooks * docs(preact-query): remove duplicated basic-mutation example from 'mutationOptions', trim boilerplate '@remarks' * docs(preact-query): add 'combine' example to 'useSuspenseQueries', link 'useSuspenseInfiniteQuery' to 'useInfiniteQuery' and document its waterfall/refetch risks * docs(preact-query): drop irrelevant 'useSuspenseQueries' reference from 'useSuspenseInfiniteQuery' waterfall remark * docs(preact-query): strengthen 'useMutation''s '@see' pointer to 'mutationOptions' with its 'mutationKey' lookup benefit * docs(preact-query): add blank lines around 'isPending'/'isError' guards for consistency with other examples
2026-08-30 13:15:47 +09:00
docs(preact-query): improve JSDoc examples across hooks and options factories (#11301) * docs(preact-query): wrap 'useIsFetching' example in a component * docs(preact-query): wrap 'useQueries' examples in components and add 'isError' handling * docs(preact-query): wrap 'useIsMutating' and 'useMutationState' examples in components * docs(preact-query): wrap 'queryOptions' examples in components * docs(preact-query): wrap 'infiniteQueryOptions' example in a component * fix(preact-query): correctly distinguish error state from loading in 'infiniteQueryOptions' example * fix(preact-query): correct mutation terminology and filter by success status in 'useMutationState' examples * docs(preact-query): destructure useInfiniteQuery result in 'infiniteQueryOptions' example * docs(preact-query): rename 'variables' to 'pendingVariables' in 'useMutationState' example * docs(preact-query): rename 'data' to 'savedPosts' in 'useMutationState' examples * docs(preact-query): rename 'results'/'result' to 'addResults'/'addResult' in 'useMutation' Promise.allSettled example * docs(preact-query): rename 'latest' to 'latestSavedPost' in 'useMutationState' example * docs(preact-query): render fetched pages and handle loading/error states in 'useInfiniteQuery' examples * docs(preact-query): render infinite query lists as '<ul>'/'<li>' instead of flat '<p>' tags * docs(preact-query): show hover-triggered prefetch instead of an unlocated 'Elsewhere' comment in 'queryOptions'/'infiniteQueryOptions' examples * docs(preact-query): move hover-prefetch examples from 'queryOptions'/'infiniteQueryOptions' to 'useQuery'/'useInfiniteQuery' * docs(preact-query): render list examples as '<ul>'/'<li>' and fix undefined refs across remaining hooks * docs(preact-query): name the prefetch id in 'queryOptions'/'infiniteQueryOptions' examples instead of an unexplained literal * docs(preact-query): add 'skipToken' examples for type-safe conditional disabling * docs(preact-query): use 'isLoading' with optional chaining in the infinite-query 'skipToken' examples * docs(preact-query): add missing 'isPending'/'isError' handling across 'queryOptions'/'useQuery'/'infiniteQueryOptions'/'useInfiniteQuery' examples * docs(preact-query): keep 'initialData' examples showing data alongside errors instead of hiding it * docs(preact-query): use scroll-triggered pagination in 'useInfiniteQuery' examples, add a 'fetchNextPage' trigger to 'infiniteQueryOptions' * docs(preact-query): guard scroll-triggered 'fetchNextPage' with 'isFetching', move cross-reference out of '@example' * docs(preact-query): move duplicated usage examples from 'queryOptions'/'infiniteQueryOptions' into their hooks * docs(preact-query): remove duplicated basic-mutation example from 'mutationOptions', trim boilerplate '@remarks' * docs(preact-query): add 'combine' example to 'useSuspenseQueries', link 'useSuspenseInfiniteQuery' to 'useInfiniteQuery' and document its waterfall/refetch risks * docs(preact-query): drop irrelevant 'useSuspenseQueries' reference from 'useSuspenseInfiniteQuery' waterfall remark * docs(preact-query): strengthen 'useMutation''s '@see' pointer to 'mutationOptions' with its 'mutationKey' lookup benefit * docs(preact-query): add blank lines around 'isPending'/'isError' guards for consistency with other examples
2026-08-30 13:15:47 +09:00