Skip to content

docs(plugin-axios,plugin-fetch): document the unwrap() method #196

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
stijnvanhulle merged 2 commits into from
Sep 2, 2026
Merged

docs(plugin-axios,plugin-fetch): document the unwrap() method #196

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7c1d78
docs(plugin-axios,plugin-fetch): document the unwrap() method
claude Sep 2, 2026
775442e
docs(plugin-axios,plugin-fetch): drop the Redux Toolkit reference
claude Sep 2, 2026
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
14 changes: 14 additions & 0 deletions snippets/how-to/calling-operations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,20 @@ if (result.status === 200) {
Reading the `error` body and handling failures is covered in
[error handling](/plugins/plugin-fetch/guide/error-handling).

## Unwrap the success body

Every call's promise also carries an `unwrap()` method. It resolves to the bare success body, or
rejects with `error` for a call made with `throwOnError: false`:

```typescript
import { getPetById } from './gen/clients/getPetById'

const pet = await getPetById({ path: { petId: 1 } }).unwrap()
// ^ the parsed pet, not the full RequestResult
```

Awaiting the call directly still resolves to the full result, so existing code keeps working.

## Set the content type

When an operation accepts or returns more than one media type, set `contentType` on the call. A
Expand Down