Plug.Conn.Cookies (Plug v1.17.4)

Conveniences for encoding and decoding cookies.

Summary

Functions

decode(cookie)

Decodes the given cookies as given in either a request or response header.

encode(key, opts \\ %{})

Encodes the given cookies as expected in a response header.

Functions

decode(cookie)

Decodes the given cookies as given in either a request or response header.

If a cookie is invalid, it is automatically discarded from the result.

Examples

iex> decode("key1=value1;key2=value2")
%{"key1" => "value1", "key2" => "value2"}

encode(key, opts \\ %{})

Encodes the given cookies as expected in a response header.

Raises if the cookie key, value, path, domain, or same-site option contains semicolon (;). It does not validate against control feed (\r), newline (\n), or null (\x00) characters as this is expected to be done by the caller when the cookie is added as a header.

Examples

iex> encode("key1", %{value: "value1"})
"key1=value1; path=/; HttpOnly"

iex> encode("key1", %{value: "value1", secure: true, path: "/example", http_only: false})
"key1=value1; path=/example; secure"