Skip to content
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

Clarify that raw disables both decompression and decoding #439

Merged
merged 3 commits into from
Dec 3, 2024
Merged

Clarify that raw disables both decompression and decoding #439

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8f69c03
Clarify that raw disables both decompression and decoding
PragTob Dec 3, 2024
3fb75e4
More explicit mention of `:raw` effects
PragTob Dec 3, 2024
b5299f3
Update lib/req/steps.ex
wojtekmach Dec 3, 2024
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
4 changes: 3 additions & 1 deletion lib/req/steps.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1391,6 +1391,8 @@ defmodule Req.Steps do
## Options

* `:raw` - if set to `true`, disables response body decompression. Defaults to `false`.

Note: `:raw` option also disables response body decoding in the `decode_body/1` step.

## Examples

Expand Down Expand Up @@ -1582,7 +1584,7 @@ defmodule Req.Steps do

* `:decode_json` - options to pass to `Jason.decode/2`, defaults to `[]`.

* `:raw` - if set to `true`, disables response body decoding. Defaults to `false`.
* `:raw` - if set to `true`, disables response body decoding & decompression. Defaults to `false`.
wojtekmach marked this conversation as resolved.
Show resolved Hide resolved

## Examples

Expand Down
Loading