Skip to content

Commit 129ba46

Browse files
committed
Improve on JSDocs of TypedUseQueryStateOptions
1 parent de2aa1d commit 129ba46

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

packages/toolkit/src/query/react/buildHooks.ts

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -431,13 +431,16 @@ export type UseQueryStateOptions<
431431
}
432432

433433
/**
434-
* Allows you to define a "pre-typed" version of
435-
* {@linkcode UseQueryStateOptions} for a specific query.
434+
* Provides a way to define a "pre-typed" version of
435+
* {@linkcode UseQueryStateOptions} with specific options for a given query.
436+
* This is particularly useful for setting default query behaviors such as
437+
* refetching strategies, which can be overridden as needed.
436438
*
437-
* @template ResultType - The type of the data returned by the query.
438-
* @template QueryArg - The type of the argument passed to the query.
439-
* @template BaseQuery - The type of the base query function used by the query.
440-
* @template SelectedResult - The type of the selected result returned by __`selectFromResult`__.
439+
*
440+
* @template ResultType - The type of the result `data` returned by the query.
441+
* @template QueryArg - The type of the argument passed into the query.
442+
* @template BaseQuery - The type of the base query function being used.
443+
* @template SelectedResult - The type of the selected result returned by the __`selectFromResult`__ function.
441444
*
442445
* @since 2.7.8
443446
* @public

0 commit comments

Comments
 (0)