Skip to content

Commit

Permalink
chore(react-query): update JSDoc for useSuspenseQueries, `useSuspen…
Browse files Browse the repository at this point in the history
…seInfiniteQuery` (#923)

# Overview

Updates the JSDoc for the `useSuspenseQueries` and
`useSuspenseInfiniteQuery` functions.

## PR Checklist

- [x] I did below actions if need

1. I read the [Contributing
Guide](https://github.com/toss/suspensive/blob/main/CONTRIBUTING.md)
2. I added documents and tests.

---------
  • Loading branch information
gwansikk authored Jun 14, 2024
1 parent 9fad40d commit 115f514
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .changeset/serious-dolls-heal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@suspensive/react-query": patch
---

fix(react-query): update JSDoc for `useSuspenseQueries`, `useSuspenseInfiniteQuery`
2 changes: 1 addition & 1 deletion packages/react-query/src/useSuspenseInfiniteQuery.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export interface UseSuspenseInfiniteQueryOptions<
> {}

/**
* This hook is wrapping useInfiniteQuery of @tanstack/react-query v4 with default suspense option.
* This hook is wrapping useInfiniteQuery of `@tanstack/react-query` v4 with default suspense option.
* @see {@link https://suspensive.org/docs/react-query/useSuspenseInfiniteQuery}
*/
export function useSuspenseInfiniteQuery<
Expand Down
4 changes: 4 additions & 0 deletions packages/react-query/src/useSuspenseQueries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,10 @@ export type SuspenseQueriesResults<
: // Fallback
Array<UseSuspenseQueryResult>

/**
* This hook is wrapping useQueries of `@tanstack/react-query` v4 with default suspense option.
* @see {@link https://suspensive.org/docs/react-query/useSuspenseQueries}
*/
export function useSuspenseQueries<T extends any[]>({
queries,
context,
Expand Down

0 comments on commit 115f514

Please sign in to comment.