Skip to content

Document module requirements for json_library() (see PR #6481) #6732

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
SteffenDE merged 3 commits into from
Jun 16, 2026
+11 −0
Merged

Document module requirements for json_library() (see PR #6481) #6732

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ba903a3
Document module requirements for json_library()
saleyn Jun 15, 2026
696be1e
Apply suggestions from code review
SteffenDE Jun 16, 2026
5393610
Apply suggestion from @SteffenDE
SteffenDE Jun 16, 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
11 changes: 11 additions & 0 deletions lib/phoenix.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,17 @@ defmodule Phoenix do

config :phoenix, :json_library, AlternativeJsonLibrary

The configured module is required to provide three functions:

- **`decode!/1`** — decodes a JSON binary, raising on invalid input
- **`encode!/1`** — encodes a term to a JSON binary, raising on encoding errors
- **`encode_to_iodata!/1`** — encodes a term to JSON as iodata, raising on
encoding errors.

These correspond to the single-argument, raising variants of
the functions provided by Elixir's built-in `JSON` module. A conforming
`:json_library` module does not need to implement any other functions
`JSON` has, that are not defined above.
"""
def json_library do
Application.get_env(:phoenix, :json_library, Jason)
Expand Down
Loading