docs(preact-query): improve JSDoc examples across hooks and options factories - #11301

Merged

sukvvon merged 31 commits into

mainfrom

docs/preact-query-examples-componentize

Aug 30, 2026

Commits on Aug 26, 2026

docs(preact-query): wrap 'useIsFetching' example in a component
sukvvon
committed
b2f7d88
docs(preact-query): wrap 'useQueries' examples in components and add 'isError' handling
sukvvon
committed
ce37641
docs(preact-query): wrap 'useIsMutating' and 'useMutationState' examples in components
sukvvon
committed
52e8c76
docs(preact-query): wrap 'queryOptions' examples in components
sukvvon
committed
0685b2e
docs(preact-query): wrap 'infiniteQueryOptions' example in a component
sukvvon
committed
28ca24c
fix(preact-query): correctly distinguish error state from loading in 'infiniteQueryOptions' example
sukvvon
committed
e553284
fix(preact-query): correct mutation terminology and filter by success status in 'useMutationState' examples
sukvvon
committed
700ce6f
docs(preact-query): destructure useInfiniteQuery result in 'infiniteQueryOptions' example
sukvvon
committed
0c086bc
docs(preact-query): rename 'variables' to 'pendingVariables' in 'useMutationState' example
sukvvon
committed
4ad73e0
docs(preact-query): rename 'data' to 'savedPosts' in 'useMutationState' examples
sukvvon
committed
5d70bbe
docs(preact-query): rename 'results'/'result' to 'addResults'/'addResult' in 'useMutation' Promise.allSettled example
sukvvon
committed
d64829f
docs(preact-query): rename 'latest' to 'latestSavedPost' in 'useMutationState' example
sukvvon
committed
64b10ce
docs(preact-query): render fetched pages and handle loading/error states in 'useInfiniteQuery' examples
sukvvon
committed
ec6828a

Commits on Aug 28, 2026

Merge branch 'main' into docs/preact-query-examples-componentize
sukvvon
authored
1741933

Navigation Menu

Uh oh!

Uh oh!

docs(preact-query): improve JSDoc examples across hooks and options factories - #11301

docs(preact-query): improve JSDoc examples across hooks and options factories#11301
sukvvon merged 31 commits into
mainfrom
docs/preact-query-examples-componentize

Commits on Aug 26, 2026

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

Commits on Aug 28, 2026

Merge branch 'main' into docs/preact-query-examples-componentize

Commits on Aug 29, 2026

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

Commits on Aug 30, 2026

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