Phoenix.LiveView.Socket (Phoenix LiveView v0.17.0) View Source

The LiveView socket for Phoenix Endpoints.

This is typically mounted directly in your endpoint.

socket "/live", Phoenix.LiveView.Socket

Link to this section Summary

Types

assigns()

The data in a LiveView as stored in the socket.

assigns_not_in_socket()

Struct returned when assigns is not in the socket.

fingerprints()

t()

Link to this section Types

assigns()

Specs

assigns() :: map() | assigns_not_in_socket()

The data in a LiveView as stored in the socket.

assigns_not_in_socket()

(opaque)

Specs

assigns_not_in_socket()

Struct returned when assigns is not in the socket.

fingerprints()

Specs

fingerprints() :: {nil, map()} | {binary(), map()}

t()

Specs

t() :: %Phoenix.LiveView.Socket{
  assigns: assigns(),
  endpoint: module(),
  fingerprints: fingerprints(),
  host_uri: URI.t() | :not_mounted_at_router,
  id: binary(),
  parent_pid: nil | pid(),
  private: map(),
  redirected: nil | tuple(),
  root_pid: pid(),
  router: module(),
  transport_pid: pid() | nil,
  view: module()
}