Add mutations guide #614
Merged
Add mutations guide #614
+1,028
−386
Conversation
This file contains hidden or 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
|
More templates
@tanstack/angular-db
@tanstack/db
@tanstack/db-ivm
@tanstack/electric-db-collection
@tanstack/query-db-collection
@tanstack/react-db
@tanstack/rxdb-db-collection
@tanstack/solid-db
@tanstack/svelte-db
@tanstack/trailbase-db-collection
@tanstack/vue-db
commit: |
|
Size Change: 0 B Total Size: 74.1 kB ℹ️ View Unchanged
|
|
Size Change: 0 B Total Size: 1.44 kB ℹ️ View Unchanged
|
thruflo
reviewed
Sep 30, 2025
KyleAMathews
force-pushed
the
mutation-doc
branch
from
3f77e7f to
63e884a
Compare
- Pull mutation off mutations array for cleaner code - Add comment explaining collection handlers only receive one mutation at a time - Apply pattern consistently across all handler examples 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
- Remove incorrect comment about single mutations - Update handlers to use Promise.all for multiple mutations - Fix collection.refetch() -> collection.utils.refetch() - Update Electric collection pattern to return txids - Add note about automatic refetch in collection handlers 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
Parenthesize the offset to ensure negative IDs: -(Math.floor(...) + 1) Previously could produce positive 1 when Math.random() returns 0
Use 'Immer-like pattern' instead of 'uses Immer under the hood'
- Correct handler params to { transaction, collection }
- Remove incorrect metadata parameter from signature
- Add metadata to mutation object properties list
- Fix return type to Promise<any> | any
Replace QueryCollection-specific note with general requirement that handlers must wait for server changes to sync back before resolving
Collection handlers automatically handle refetch, only custom actions need it
- Make mutationFn required (not optional) - Add missing id and metadata options - Mark autoCommit as optional
Note that rollback is automatic on error, manual rollback only needed for user actions like canceling a form
- Replace opening paragraph with bullet points - Remove worked examples, keep truth table only - Remove redundant benefits list
thruflo
approved these changes
Oct 1, 2025
|
|
||
| ```tsx | ||
| // Intent: "like this post" | ||
| const likePost = createOptimisticAction<string>({ |
There was a problem hiding this comment.
Is it worth showing how to use this, i.e.:
likePost(postId)
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.
Add new mutations guide consolidating material & docs & examples.
Fixes #547