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

gwansikk · 2024-10-22T15:13:15Z

Overview

close: #1303

I have written the official documentation for <Mutation/>

PR Checklist

I did below actions if need

I read the Contributing Guide
I added documents and tests.

coauthors · 2024-10-22T15:13:18Z

People can be co-author:

Candidate	Reasons	Count	Add this as commit message
@gwansikk	#1335 (comment) #1335	2	`Co-authored-by: gwansikk <[email protected]>`
@codecov-commenter	#1335 (comment)	1	`Co-authored-by: codecov-commenter <[email protected]>`
@manudeli	#1335 (review)	1	`Co-authored-by: manudeli <[email protected]>`

changeset-bot · 2024-10-22T15:13:19Z

⚠️ No Changeset found

Latest commit: c88c62f

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 · 2024-10-22T15:13:19Z

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 · 2024-10-22T15:14:44Z

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 · 2024-10-22T15:15:08Z

CodSpeed Performance Report

Merging #1335 will create unknown performance changes

_{Comparing feature/docs/mutation (c88c62f) with main (f72d0a6)}

Summary

⚠️ No benchmarks were detected in both the base of the PR and the PR.

codecov-commenter · 2024-10-22T15:15:48Z

Codecov Report

All modified and coverable lines are covered by tests ✅

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

Additional details and impacted files

@@           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	Coverage Δ
@suspensive/react	`100.00% <ø> (ø)`
@suspensive/react-dom	`100.00% <ø> (ø)`
@suspensive/react-native	`100.00% <ø> (ø)`
@suspensive/react-query	`72.86% <ø> (ø)`
@suspensive/react-query-4	`0.00% <ø> (ø)`
@suspensive/react-query-5	`0.00% <ø> (ø)`
@suspensive/jotai	`0.00% <ø> (ø)`

gwansikk · 2024-10-22T15:46:17Z

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

manudeli

Cool!👍

docs: add docs for <QueryClientConsumer>

c88c62f

gwansikk linked an issue Oct 22, 2024 that may be closed by this pull request

[Docs]: Doc for Mutation #1303

Closed

github-actions bot added the suspensive.org label Oct 22, 2024

gwansikk requested review from kangju2000, bigsaigon333 and SEOKKAMONI October 22, 2024 15:13

vercel bot deployed to Preview – suspensive.org October 22, 2024 15:14 View deployment

vercel bot deployed to Preview – v1.suspensive.org October 22, 2024 15:15 View deployment

gwansikk marked this pull request as ready for review October 22, 2024 15:18

gwansikk requested a review from manudeli as a code owner October 22, 2024 15:18

manudeli approved these changes Oct 22, 2024

View reviewed changes

manudeli merged commit e9d4785 into main Oct 22, 2024
18 checks passed

manudeli deleted the feature/docs/mutation branch October 22, 2024 20:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

gwansikk commented Oct 22, 2024

coauthors bot commented Oct 22, 2024 •

edited

Loading

changeset-bot bot commented Oct 22, 2024

vercel bot commented Oct 22, 2024 •

edited

Loading

github-actions bot commented Oct 22, 2024

codspeed-hq bot commented Oct 22, 2024

codecov-commenter commented Oct 22, 2024

gwansikk commented Oct 22, 2024

manudeli left a comment

docs: add docs for <Mutation/> #1335

docs: add docs for <Mutation/> #1335

Conversation

gwansikk commented Oct 22, 2024

Overview

PR Checklist

coauthors bot commented Oct 22, 2024 • edited Loading

People can be co-author:

changeset-bot bot commented Oct 22, 2024

⚠️ No Changeset found

vercel bot commented Oct 22, 2024 • edited Loading

github-actions bot commented Oct 22, 2024

codspeed-hq bot commented Oct 22, 2024

CodSpeed Performance Report

Merging #1335 will create unknown performance changes

Summary

codecov-commenter commented Oct 22, 2024

Codecov Report

gwansikk commented Oct 22, 2024

manudeli left a comment

Choose a reason for hiding this comment

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

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

coauthors bot commented Oct 22, 2024 •

edited

Loading

vercel bot commented Oct 22, 2024 •

edited

Loading