add example code to Plug.Conn.Cookies.encode/2

elixir-plug · Dec 22, 2024 · 3bbba9f · 3bbba9f
1 parent b469e1c
commit 3bbba9f
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/lib/plug/conn/cookies.ex b/lib/plug/conn/cookies.ex
@@ -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)