Phoenix
Phoenix v1.6.4

View Source Phoenix (Phoenix v1.6.4)

This is the documentation for the Phoenix project.

By default, Phoenix applications depend on the following packages across these categories.

General

  • Ecto - a language integrated query and database wrapper

  • ExUnit - Elixir's built-in test framework

  • Gettext - Internationalization and localization through gettext

  • Phoenix - the Phoenix web framework (these docs)

  • Phoenix PubSub - a distributed pub/sub system with presence support

  • Phoenix HTML - conveniences for working with HTML in Phoenix

  • Phoenix View - a set of functions for building Phoenix.View and working with template languages such as Elixir's own EEx

  • Phoenix LiveView - rich, real-time user experiences with server-rendered HTML

  • Phoenix LiveDashboard - real-time performance monitoring and debugging tools for Phoenix developers

  • Plug - a specification and conveniences for composable modules in between web applications

  • Swoosh - a library for composing, delivering and testing emails, also used by mix phx.gen.auth

  • Telemetry Metrics - common interface for defining metrics based on Telemetry events

To get started, see our overview guides.

Link to this section Summary

Functions

json_library()

Returns the configured JSON encoding library for Phoenix.

plug_init_mode()

Returns the :plug_init_mode that controls when plugs are initialized.

Link to this section Functions

Link to this function

json_library()

View Source

Returns the configured JSON encoding library for Phoenix.

To customize the JSON library, including the following in your config/config.exs:

config :phoenix, :json_library, AlternativeJsonLibrary
Link to this function

plug_init_mode()

View Source

Returns the :plug_init_mode that controls when plugs are initialized.

We recommend to set it to :runtime in development for compilation time improvements. It must be :compile in production (the default).

This option is passed as the :init_mode to Plug.Builder.compile/3.