-
Notifications
You must be signed in to change notification settings - Fork 352
Make EncodeJson/DecodeJson middlewares public #590
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.
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
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -12,6 +12,9 @@ defmodule Tesla.Middleware.JSON do | |
mix deps.compile tesla | ||
``` | ||
|
||
If you only need to encode the request body or decode the response body, | ||
you can use `Tesla.Middleware.EncodeJson` or `Tesla.Middleware.DecodeJson` directly instead. | ||
|
||
## Examples | ||
|
||
``` | ||
|
@@ -61,6 +64,7 @@ defmodule Tesla.Middleware.JSON do | |
|
||
It is used by `Tesla.Middleware.EncodeJson`. | ||
""" | ||
@spec encode(Tesla.Env.t(), keyword()) :: Tesla.Env.result() | ||
def encode(env, opts) do | ||
with true <- encodable?(env), | ||
{:ok, body} <- encode_body(env.body, opts) do | ||
|
@@ -98,6 +102,7 @@ defmodule Tesla.Middleware.JSON do | |
|
||
It is used by `Tesla.Middleware.DecodeJson`. | ||
""" | ||
@spec decode(Tesla.Env.t(), keyword()) :: Tesla.Env.result() | ||
def decode(env, opts) do | ||
with true <- decodable?(env, opts), | ||
{:ok, body} <- decode_body(env.body, opts) do | ||
|
@@ -151,7 +156,15 @@ defmodule Tesla.Middleware.JSON do | |
end | ||
|
||
defmodule Tesla.Middleware.DecodeJson do | ||
@moduledoc false | ||
@moduledoc """ | ||
Decodes response body as JSON. | ||
|
||
Only decodes the body if the `Content-Type` header suggests | ||
that the body is JSON. | ||
""" | ||
@moduledoc since: "1.8.0" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Next version. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The funny part is that I do know people using the module already 😄 |
||
|
||
@impl Tesla.Middleware | ||
def call(env, next, opts) do | ||
opts = opts || [] | ||
|
||
|
@@ -162,7 +175,12 @@ defmodule Tesla.Middleware.DecodeJson do | |
end | ||
|
||
defmodule Tesla.Middleware.EncodeJson do | ||
@moduledoc false | ||
@moduledoc """ | ||
Encodes request body as JSON. | ||
""" | ||
@moduledoc since: "1.8.0" | ||
|
||
@impl Tesla.Middleware | ||
def call(env, next, opts) do | ||
opts = opts || [] | ||
|
||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added spec (here and below) since these functions are public.