LightningWeb.Plugs.Redirect (Lightning v2.14.5-pre1)

View Source

A plug for redirecting requests to a specified URL.

This plug takes an option :to which specifies the target URL for the redirection.

Summary

Functions

call(conn, action)

Redirects the connection to the specified URL.

init(opts)

Initializes the plug options.

Functions

call(conn, action)

Redirects the connection to the specified URL.

Parameters

  • conn: The connection struct.
  • opts: A keyword list of options. Must include :to key specifying the target URL.

Examples

iex> conn = %Plug.Conn{}
iex> opts = [to: "/new_path"]
iex> LightningWeb.Plugs.Redirect.call(conn, opts)
%Plug.Conn{...}

Raises

KeyError if the :to key is not present in options.

init(opts)

Initializes the plug options.

Parameters

  • opts: A keyword list of options.

Returns

The provided options are returned as they are.

Examples

iex> LightningWeb.Plugs.Redirect.init(to: "/new_path")
[to: "/new_path"]