Skip to content

Add example code to Plug.Conn.Cookies.encode/2 #1256

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
josevalim merged 1 commit into from
Dec 22, 2024
+8 −0
Merged

Add example code to Plug.Conn.Cookies.encode/2 #1256

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions lib/plug/conn/cookies.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@ defmodule Plug.Conn.Cookies do

@doc """
Encodes the given cookies as expected in a response 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"
"""
def encode(key, opts \\ %{}) when is_map(opts) do
value = Map.get(opts, :value)
Expand Down