Skip to content

docs: add responseType quick reference table to REST guide #7

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
TDanks2000 merged 1 commit into from
May 19, 2026
Merged

docs: add responseType quick reference table to REST guide #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions docs/guides/rest-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,16 @@ await client.get("/movies", {
| `responseType` | Override response parsing with `json`, `text`, `arrayBuffer`, or `blob`. Defaults to `auto`. |
| `errorResponseType` | Override non-2xx body parsing. Defaults to `auto`. |

### `responseType` quick reference

| `responseType` | Returns | Common use case |
| --- | --- | --- |
| `auto` (default) | Auto-detected value from `content-type` (`json`, `text`, or binary fallback) | Most API calls where response format is standard and predictable. |
| `json` | Parsed JSON value | REST/GraphQL responses that always return structured JSON. |
| `text` | UTF-8 string | Plain text endpoints, HTML fragments, or server messages. |
| `arrayBuffer` | `ArrayBuffer` | File downloads, protobuf payloads, or any binary processing pipeline. |
| `blob` | `Blob` (when available) | Browser-first file handling, previews, and upload/download flows. |

`headers` and `defaultHeaders` accept any `HeadersInit` shape: plain objects,
native `Headers`, or `[name, value]` tuples. Header names are normalized
case-insensitively before the request reaches plugins or transports.
Expand Down