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

Improve exception message for Jason.Encoder errors #4534

Merged
merged 2 commits into from
Oct 30, 2024
Merged

Improve exception message for Jason.Encoder errors #4534

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7282f7b
Improve exception message for Jason.Encoder errors
ivanov Oct 29, 2024
9509210
Update json.ex
josevalim Oct 30, 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
8 changes: 7 additions & 1 deletion lib/ecto/json.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ if Code.ensure_loaded?(Jason.Encoder) do

@derive {Jason.Encoder, only: [:name, :title, ...]}
schema ... do

You can also use the :except option instead of :only if you would \
prefer to skip some fields.
"""
end
end
Expand All @@ -29,13 +32,16 @@ if Code.ensure_loaded?(Jason.Encoder) do
exposed externally.

You can either map the schemas to remove the :__meta__ field before \
encoding to JSON, or explicitly list the JSON fields in your schema:
encoding or explicitly list the JSON fields in your schema:

defmodule #{inspect(schema)} do
# ...

@derive {Jason.Encoder, only: [:name, :title, ...]}
schema ... do

You can also use the :except option instead of :only if you would \
prefer to skip some fields.
"""
end
end
Expand Down
Loading