aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cow_cookie.setcookie.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2019-10-04 15:19:17 +0200
committerLoïc Hoguin <[email protected]>2019-10-04 15:19:17 +0200
commitbd32d879e151ba6fa1732b4eee6cac064846e9cc (patch)
treed9605b974f102327b6c096f413d0c7b797768353 /doc/src/manual/cow_cookie.setcookie.asciidoc
parent6a4f901c7938a070cf7a80fdb366e17f8a300aff (diff)
downloadcowlib-bd32d879e151ba6fa1732b4eee6cac064846e9cc.tar.gz
cowlib-bd32d879e151ba6fa1732b4eee6cac064846e9cc.tar.bz2
cowlib-bd32d879e151ba6fa1732b4eee6cac064846e9cc.zip
Add manual for cow_cookie
Diffstat (limited to 'doc/src/manual/cow_cookie.setcookie.asciidoc')
-rw-r--r--doc/src/manual/cow_cookie.setcookie.asciidoc55
1 files changed, 55 insertions, 0 deletions
diff --git a/doc/src/manual/cow_cookie.setcookie.asciidoc b/doc/src/manual/cow_cookie.setcookie.asciidoc
new file mode 100644
index 0000000..ab2d466
--- /dev/null
+++ b/doc/src/manual/cow_cookie.setcookie.asciidoc
@@ -0,0 +1,55 @@
+= cow_cookie:setcookie(3)
+
+== Name
+
+cow_cookie:setcookie - Generate a set-cookie header
+
+== Description
+
+[source,erlang]
+----
+setcookie(Name :: iodata(),
+ Value :: iodata(),
+ Opts :: cow_cookie:cookie_opts())
+ -> iolist()
+----
+
+Generate a set-cookie header.
+
+== Arguments
+
+Name::
+
+Cookie name.
+
+Value::
+
+Cookie value.
+
+Opts::
+
+Options added to the set-cookie header as attributes.
+
+== Return value
+
+An iolist with the generated set-cookie header value.
+
+== Changelog
+
+* *1.0*: Function introduced.
+
+== Examples
+
+.Generate a set-cookie header
+[source,erlang]
+----
+SetCookie = cow_cookie:setcookie(<<"sessionid">>, ID, #{
+ http_only => true,
+ secure => true
+}).
+----
+
+== See also
+
+link:man:cow_cookie(3)[cow_cookie(3)],
+link:man:cow_cookie:parse_cookie(3)[cow_cookie:parse_cookie(3)]