search

toss / suspensive

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

docs: add docs for `<Mutation/>` #1335

Closed gwansikk closed 1 month ago

gwansikk commented 1 month ago

Overview

close: #1303

I have written the official documentation for <Mutation/>

PR Checklist

  1. I read the Contributing Guide
  2. I added documents and tests.
coauthors[bot] commented 1 month ago

People can be co-author:

Candidate Reasons Count Add this as commit message
@gwansikk https://github.com/toss/suspensive/pull/1335#issuecomment-2429643894 https://github.com/toss/suspensive/pull/1335 2 Co-authored-by: gwansikk <39869096+gwansikk@users.noreply.github.com>
@codecov-commenter https://github.com/toss/suspensive/pull/1335#issuecomment-2429568091 1 Co-authored-by: codecov-commenter <65553080+codecov-commenter@users.noreply.github.com>
@manudeli https://github.com/toss/suspensive/pull/1335#pullrequestreview-2386254612 1 Co-authored-by: manudeli <61593290+manudeli@users.noreply.github.com>
changeset-bot[bot] commented 1 month ago

⚠️ No Changeset found

Latest commit: c88c62f5ab3c8e722fe74f96bcc802c6a5286a4a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel[bot] commented 1 month 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 Oct 22, 2024 3:15pm
v1.suspensive.org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 22, 2024 3:15pm
visualization.suspensive.org ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 22, 2024 3:15pm
github-actions[bot] commented 1 month ago

Size Change: 0 B

Total Size: 64.2 kB

ℹ️ 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` | 393 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/PrefetchQuery.js` | 146 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/SuspenseQuery.js` | 147 B | | `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-4/dist/useSuspenseQuery.js` | 140 B | | `packages/react-query-5/dist/index.cjs` | 1.76 kB | | `packages/react-query-5/dist/index.js` | 392 B | | `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` | 206 B | | `packages/react/dist/ErrorBoundaryGroup.cjs` | 1.38 kB | | `packages/react/dist/ErrorBoundaryGroup.js` | 196 B | | `packages/react/dist/index.cjs` | 4.33 kB | | `packages/react/dist/index.js` | 367 B | | `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` | 208 B |

compressed-size-action

codspeed-hq[bot] commented 1 month ago

CodSpeed Performance Report

Merging #1335 will create unknown performance changes

Comparing feature/docs/mutation (c88c62f) with main (f72d0a6)

Summary

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

codecov-commenter commented 1 month ago

Codecov Report

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

Project coverage is 76.69%. Comparing base (f72d0a6) to head (c88c62f).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/toss/suspensive/pull/1335/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/1335?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) ```diff @@ Coverage Diff @@ ## main #1335 +/- ## ======================================= Coverage 76.69% 76.69% ======================================= Files 63 63 Lines 502 502 Branches 111 111 ======================================= Hits 385 385 Misses 111 111 Partials 6 6 ``` | [Components](https://app.codecov.io/gh/toss/suspensive/pull/1335/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/1335/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/1335/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/1335/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/1335/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/1335/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/1335/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/1335/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=toss) | `0.00% <ø> (ø)` | |
gwansikk commented 1 month ago
image

Oops.. it seems the commit title is incorrect. That was my mistake.