toss / suspensive

All in one for React Suspense
https://suspensive.org
MIT License
540 stars 52 forks source link

fix(react-query, jotai, react): fix typo in jsdoc #1364

Closed kangju2000 closed 2 days ago

kangju2000 commented 3 days ago

Overview

PR Checklist

  1. I read the Contributing Guide
  2. I added documents and tests.
changeset-bot[bot] commented 3 days ago

🦋 Changeset detected

Latest commit: eff5ff6581b8b690e14fb6d293ab8559d05b45f4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 5 packages | Name | Type | | ------------------------- | ----- | | @suspensive/jotai | Patch | | @suspensive/react-query-4 | Patch | | @suspensive/react-query-5 | Patch | | @suspensive/react | Patch | | @suspensive/react-query | Patch |

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

vercel[bot] commented 3 days ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
suspensive.org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 20, 2024 1:47am
v1.suspensive.org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 20, 2024 1:47am
visualization.suspensive.org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 20, 2024 1:47am
coauthors[bot] commented 3 days ago

People can be co-author:

Candidate Reasons Count Add this as commit message
@kangju2000 https://github.com/toss/suspensive/pull/1364 1 Co-authored-by: kangju2000 <23312485+kangju2000@users.noreply.github.com>
@codecov-commenter https://github.com/toss/suspensive/pull/1364#issuecomment-2486457574 1 Co-authored-by: codecov-commenter <65553080+codecov-commenter@users.noreply.github.com>
@gwansikk https://github.com/toss/suspensive/pull/1364#issuecomment-2487485822 1 Co-authored-by: gwansikk <39869096+gwansikk@users.noreply.github.com>
@manudeli https://github.com/toss/suspensive/pull/1364#pullrequestreview-2447167381 1 Co-authored-by: manudeli <61593290+manudeli@users.noreply.github.com>
github-actions[bot] commented 3 days ago

Size Change: -4 B (-0.01%)

Total Size: 64.2 kB

Filename Size Change
packages/react-query-4/dist/PrefetchQuery.js 147 B +1 B (+0.68%)
packages/react-query-4/dist/SuspenseQuery.js 146 B -1 B (-0.68%)
packages/react-query-4/dist/useSuspenseQuery.js 139 B -1 B (-0.71%)
packages/react-query-5/dist/index.js 389 B -2 B (-0.51%)
packages/react/dist/index.js 368 B -1 B (-0.27%)
ℹ️ View Unchanged | Filename | Size | | :--- | :---: | | `packages/jotai/dist/Atom.cjs` | 660 B | | `packages/jotai/dist/Atom.js` | 115 B | | `packages/jotai/dist/AtomValue.cjs` | 647 B | | `packages/jotai/dist/AtomValue.js` | 120 B | | `packages/jotai/dist/index.cjs` | 755 B | | `packages/jotai/dist/index.js` | 158 B | | `packages/jotai/dist/SetAtom.cjs` | 645 B | | `packages/jotai/dist/SetAtom.js` | 118 B | | `packages/react-dom/dist/index.cjs` | 2.11 kB | | `packages/react-dom/dist/index.js` | 139 B | | `packages/react-dom/dist/InView.cjs` | 2.1 kB | | `packages/react-dom/dist/InView.js` | 130 B | | `packages/react-dom/dist/useInView.cjs` | 1.87 kB | | `packages/react-dom/dist/useInView.js` | 120 B | | `packages/react-native/dist/index.cjs` | 619 B | | `packages/react-native/dist/index.js` | 122 B | | `packages/react-native/dist/TestText.cjs` | 612 B | | `packages/react-native/dist/TestText.js` | 119 B | | `packages/react-query-4/dist/index.cjs` | 1.86 kB | | `packages/react-query-4/dist/index.js` | 394 B | | `packages/react-query-4/dist/infiniteQueryOptions.cjs` | 548 B | | `packages/react-query-4/dist/infiniteQueryOptions.js` | 144 B | | `packages/react-query-4/dist/Mutation.cjs` | 821 B | | `packages/react-query-4/dist/Mutation.js` | 132 B | | `packages/react-query-4/dist/PrefetchInfiniteQuery.cjs` | 722 B | | `packages/react-query-4/dist/PrefetchInfiniteQuery.js` | 155 B | | `packages/react-query-4/dist/PrefetchQuery.cjs` | 712 B | | `packages/react-query-4/dist/QueryClientConsumer.cjs` | 665 B | | `packages/react-query-4/dist/QueryClientConsumer.js` | 139 B | | `packages/react-query-4/dist/QueryErrorBoundary.cjs` | 1.12 kB | | `packages/react-query-4/dist/QueryErrorBoundary.js` | 142 B | | `packages/react-query-4/dist/queryOptions.cjs` | 540 B | | `packages/react-query-4/dist/queryOptions.js` | 136 B | | `packages/react-query-4/dist/SuspenseInfiniteQuery.cjs` | 1.05 kB | | `packages/react-query-4/dist/SuspenseInfiniteQuery.js` | 155 B | | `packages/react-query-4/dist/SuspenseQueries.cjs` | 923 B | | `packages/react-query-4/dist/SuspenseQueries.js` | 149 B | | `packages/react-query-4/dist/SuspenseQuery.cjs` | 1.04 kB | | `packages/react-query-4/dist/usePrefetchInfiniteQuery.cjs` | 648 B | | `packages/react-query-4/dist/usePrefetchInfiniteQuery.js` | 148 B | | `packages/react-query-4/dist/usePrefetchQuery.cjs` | 639 B | | `packages/react-query-4/dist/usePrefetchQuery.js` | 140 B | | `packages/react-query-4/dist/useSuspenseInfiniteQuery.cjs` | 833 B | | `packages/react-query-4/dist/useSuspenseInfiniteQuery.js` | 148 B | | `packages/react-query-4/dist/useSuspenseQueries.cjs` | 833 B | | `packages/react-query-4/dist/useSuspenseQueries.js` | 142 B | | `packages/react-query-4/dist/useSuspenseQuery.cjs` | 824 B | | `packages/react-query-5/dist/index.cjs` | 1.76 kB | | `packages/react-query-5/dist/infiniteQueryOptions.cjs` | 573 B | | `packages/react-query-5/dist/infiniteQueryOptions.js` | 144 B | | `packages/react-query-5/dist/Mutation.cjs` | 821 B | | `packages/react-query-5/dist/Mutation.js` | 132 B | | `packages/react-query-5/dist/PrefetchInfiniteQuery.cjs` | 647 B | | `packages/react-query-5/dist/PrefetchInfiniteQuery.js` | 145 B | | `packages/react-query-5/dist/PrefetchQuery.cjs` | 639 B | | `packages/react-query-5/dist/PrefetchQuery.js` | 137 B | | `packages/react-query-5/dist/QueryClientConsumer.cjs` | 663 B | | `packages/react-query-5/dist/QueryClientConsumer.js` | 140 B | | `packages/react-query-5/dist/QueryErrorBoundary.cjs` | 1.12 kB | | `packages/react-query-5/dist/QueryErrorBoundary.js` | 142 B | | `packages/react-query-5/dist/queryOptions.cjs` | 563 B | | `packages/react-query-5/dist/queryOptions.js` | 136 B | | `packages/react-query-5/dist/SuspenseInfiniteQuery.cjs` | 833 B | | `packages/react-query-5/dist/SuspenseInfiniteQuery.js` | 145 B | | `packages/react-query-5/dist/SuspenseQueries.cjs` | 671 B | | `packages/react-query-5/dist/SuspenseQueries.js` | 139 B | | `packages/react-query-5/dist/SuspenseQuery.cjs` | 825 B | | `packages/react-query-5/dist/SuspenseQuery.js` | 137 B | | `packages/react-query-5/dist/usePrefetchInfiniteQuery.cjs` | 577 B | | `packages/react-query-5/dist/usePrefetchInfiniteQuery.js` | 148 B | | `packages/react-query-5/dist/usePrefetchQuery.cjs` | 569 B | | `packages/react-query-5/dist/usePrefetchQuery.js` | 140 B | | `packages/react-query-5/dist/useSuspenseInfiniteQuery.cjs` | 577 B | | `packages/react-query-5/dist/useSuspenseInfiniteQuery.js` | 148 B | | `packages/react-query-5/dist/useSuspenseQueries.cjs` | 571 B | | `packages/react-query-5/dist/useSuspenseQueries.js` | 142 B | | `packages/react-query-5/dist/useSuspenseQuery.cjs` | 569 B | | `packages/react-query-5/dist/useSuspenseQuery.js` | 140 B | | `packages/react-query/dist/index.cjs` | 551 B | | `packages/react-query/dist/index.js` | 121 B | | `packages/react-query/dist/v4.cjs` | 550 B | | `packages/react-query/dist/v4.js` | 116 B | | `packages/react-query/dist/v5.cjs` | 550 B | | `packages/react-query/dist/v5.js` | 116 B | | `packages/react/dist/ClientOnly.cjs` | 734 B | | `packages/react/dist/ClientOnly.js` | 141 B | | `packages/react/dist/DefaultProps.cjs` | 1.05 kB | | `packages/react/dist/DefaultProps.js` | 167 B | | `packages/react/dist/Delay.cjs` | 1.23 kB | | `packages/react/dist/Delay.js` | 159 B | | `packages/react/dist/DevMode.cjs` | 530 B | | `packages/react/dist/DevMode.js` | 131 B | | `packages/react/dist/ErrorBoundary.cjs` | 2.74 kB | | `packages/react/dist/ErrorBoundary.js` | 205 B | | `packages/react/dist/ErrorBoundaryGroup.cjs` | 1.38 kB | | `packages/react/dist/ErrorBoundaryGroup.js` | 196 B | | `packages/react/dist/index.cjs` | 4.32 kB | | `packages/react/dist/Suspense.cjs` | 1.29 kB | | `packages/react/dist/Suspense.js` | 172 B | | `packages/react/dist/Suspensive.cjs` | 1.26 kB | | `packages/react/dist/Suspensive.js` | 175 B | | `packages/react/dist/wrap.cjs` | 3.78 kB | | `packages/react/dist/wrap.js` | 211 B |

compressed-size-action

codecov-commenter commented 3 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 71.86%. Comparing base (2d4e68f) to head (eff5ff6).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/toss/suspensive/pull/1364/graphs/tree.svg?width=650&height=150&src=pr&token=5PopssACmx&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss)](https://app.codecov.io/gh/toss/suspensive/pull/1364?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) ```diff @@ Coverage Diff @@ ## main #1364 +/- ## ======================================= Coverage 71.86% 71.86% ======================================= Files 67 67 Lines 583 583 Branches 129 129 ======================================= Hits 419 419 Misses 151 151 Partials 13 13 ``` | [Components](https://app.codecov.io/gh/toss/suspensive/pull/1364/components?src=pr&el=components&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | Coverage Δ | | |---|---|---| | [@suspensive/react](https://app.codecov.io/gh/toss/suspensive/pull/1364/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `100.00% <ø> (ø)` | | | [@suspensive/react-dom](https://app.codecov.io/gh/toss/suspensive/pull/1364/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `100.00% <ø> (ø)` | | | [@suspensive/react-native](https://app.codecov.io/gh/toss/suspensive/pull/1364/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `100.00% <ø> (ø)` | | | [@suspensive/react-query](https://app.codecov.io/gh/toss/suspensive/pull/1364/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `72.86% <ø> (ø)` | | | [@suspensive/react-query-4](https://app.codecov.io/gh/toss/suspensive/pull/1364/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `0.00% <ø> (ø)` | | | [@suspensive/react-query-5](https://app.codecov.io/gh/toss/suspensive/pull/1364/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `0.00% <ø> (ø)` | | | [@suspensive/jotai](https://app.codecov.io/gh/toss/suspensive/pull/1364/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `0.00% <ø> (ø)` | | | [@suspensive/codemods](https://app.codecov.io/gh/toss/suspensive/pull/1364/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `41.97% <ø> (ø)` | |

🚨 Try these New Features:

codspeed-hq[bot] commented 3 days ago

CodSpeed Performance Report

Merging #1364 will create unknown performance changes

Comparing fix/typo-jsDoc (eff5ff6) with main (2d4e68f)

Summary

:warning: No benchmarks were detected in both the base of the PR and the PR.

gwansikk commented 2 days ago

Thanks 😍