chore(react-query): update JSDoc for useSuspenseQueries, useSuspenseInfiniteQuery
#923
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: bce9865 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
gwansikk
commented
Jun 14, 2024
| @@ -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. | |||
There was a problem hiding this comment.
I've made revisions for consistency.
There was a problem hiding this comment.
Thanks! So much better jsdoc 👍
AS-IS
TO BE
gwansikk
commented
Jun 14, 2024
| @@ -109,6 +109,10 @@ export type SuspenseQueriesResults< | |||
| : // Fallback | |||
| Array<UseSuspenseQueryResult> | |||
|
|
|||
| /** | |||
| * This hook is wrapping useQueries of `@tanstack/react-query` v4 with default suspense option. | |||
There was a problem hiding this comment.
I added the JSDoc for this function as it was missing.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #923 +/- ##
=======================================
Coverage 83.44% 83.44%
=======================================
Files 33 33
Lines 435 435
Branches 99 100 +1
=======================================
Hits 363 363
Misses 62 62
Partials 10 10
|
manudeli
approved these changes
Jun 14, 2024
|
Thanks! You made so much better jsdoc! |
Merged
manudeli
pushed a commit
that referenced
this pull request
Jun 14, 2024
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @suspensive/react-query@2.0.6 ### Patch Changes - [#923](#923) [`1e7fbbe`](1e7fbbe) Thanks [@gwansikk](https://github.com/gwansikk)! - fix(react-query): update JSDoc for `useSuspenseQueries`, `useSuspenseInfiniteQuery` - Updated dependencies \[]: - @suspensive/react@2.0.6 ## @suspensive/react@2.0.6 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
manudeli
added a commit
that referenced
this pull request
Aug 3, 2024
…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. --------- Co-authored-by: Jonghyeon Ko <jonghyeon@toss.im>
manudeli
added a commit
that referenced
this pull request
Aug 3, 2024
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @suspensive/react-query@2.0.6 ### Patch Changes - [#923](#923) [`1e7fbbe`](1e7fbbe) Thanks [@gwansikk](https://github.com/gwansikk)! - fix(react-query): update JSDoc for `useSuspenseQueries`, `useSuspenseInfiniteQuery` - Updated dependencies \[]: - @suspensive/react@2.0.6 ## @suspensive/react@2.0.6 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
manudeli
pushed a commit
that referenced
this pull request
Aug 3, 2024
…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. ---------
manudeli
added a commit
that referenced
this pull request
Aug 3, 2024
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @suspensive/react-query@2.0.6 ### Patch Changes - [#923](#923) [`1e7fbbe`](1e7fbbe) Thanks [@gwansikk](https://github.com/gwansikk)! - fix(react-query): update JSDoc for `useSuspenseQueries`, `useSuspenseInfiniteQuery` - Updated dependencies \[]: - @suspensive/react@2.0.6 ## @suspensive/react@2.0.6
manudeli
added a commit
that referenced
this pull request
Aug 3, 2024
…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. --------- Co-authored-by: Jonghyeon Ko <jonghyeon@toss.im>
manudeli
added a commit
that referenced
this pull request
Aug 3, 2024
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @suspensive/react-query@2.0.6 ### Patch Changes - [#923](#923) [`1e7fbbe`](1e7fbbe) Thanks [@gwansikk](https://github.com/gwansikk)! - fix(react-query): update JSDoc for `useSuspenseQueries`, `useSuspenseInfiniteQuery` - Updated dependencies \[]: - @suspensive/react@2.0.6 ## @suspensive/react@2.0.6
manudeli
added a commit
that referenced
this pull request
Aug 3, 2024
…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. --------- Co-authored-by: Jonghyeon Ko <jonghyeon@toss.im>
manudeli
added a commit
that referenced
this pull request
Aug 3, 2024
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @suspensive/react-query@2.0.6 ### Patch Changes - [#923](#923) [`1e7fbbe`](1e7fbbe) Thanks [@gwansikk](https://github.com/gwansikk)! - fix(react-query): update JSDoc for `useSuspenseQueries`, `useSuspenseInfiniteQuery` - Updated dependencies \[]: - @suspensive/react@2.0.6 ## @suspensive/react@2.0.6
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Updates the JSDoc for the
useSuspenseQueriesanduseSuspenseInfiniteQueryfunctions.PR Checklist