Skip to content

docs: document mutations params argument #259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
michael-small merged 2 commits into from
Dec 3, 2025
Merged

docs: document mutations params argument #259

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc7f97d
docs: document params argument
freon27 Dec 2, 2025
ff6a8e8
Update docs/docs/mutations.md
freon27 Dec 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion docs/docs/mutations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,12 @@ httpMutation({

### Callbacks

In the mutation: _optional_ `onSuccess` and `onError` callbacks
In the mutation: _optional_ `onSuccess` and `onError` callbacks.

The callbacks are called with two parameters:

1. The result of the mutation (`onSuccess`) or the error (`onError`)
2. The parameter passed when calling the mutation

```ts
({
Expand All @@ -159,6 +164,14 @@ In the mutation: _optional_ `onSuccess` and `onError` callbacks
console.error('Error occurred:', error);
},
});

// using the passed parameter
({
onSuccess: (_result, params) => {
// after successful deletion
store.listResource.set(store.listResource.value().filter((item) => item.id !== params.id));
},
});
```

### Flattening operators
Expand Down