diff options
author | Loïc Hoguin <[email protected]> | 2020-03-19 14:56:49 +0100 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2020-03-19 14:56:49 +0100 |
commit | 8a9f7dcb43c0b5e4d11bc63bfd0f23e2740fac7e (patch) | |
tree | adc7f19cfa10cad2b6030eff73a02f5eec798554 /doc/src/manual/cow_cookie.cookie.asciidoc | |
parent | f017f8a0ecbffd5033d9ab49bf180186f7a523a7 (diff) | |
download | cowlib-8a9f7dcb43c0b5e4d11bc63bfd0f23e2740fac7e.tar.gz cowlib-8a9f7dcb43c0b5e4d11bc63bfd0f23e2740fac7e.tar.bz2 cowlib-8a9f7dcb43c0b5e4d11bc63bfd0f23e2740fac7e.zip |
Document the new cow_cookie functions
Diffstat (limited to 'doc/src/manual/cow_cookie.cookie.asciidoc')
-rw-r--r-- | doc/src/manual/cow_cookie.cookie.asciidoc | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/src/manual/cow_cookie.cookie.asciidoc b/doc/src/manual/cow_cookie.cookie.asciidoc new file mode 100644 index 0000000..c40d66b --- /dev/null +++ b/doc/src/manual/cow_cookie.cookie.asciidoc @@ -0,0 +1,45 @@ += cow_cookie:cookie(3) + +== Name + +cow_cookie:cookie - Generate a cookie header + +== Description + +[source,erlang] +---- +cookie(Cookies) -> iolist() + +Cookies :: [{Name :: iodata(), Value :: iodata()}] +---- + +Generate a cookie header. + +== Arguments + +Cookies:: + +A list of pairs of cookie name and value. + +== Return value + +An iolist with the generated cookie header value. + +== Changelog + +* *2.9*: Function introduced. + +== Examples + +.Generate a cookie header +[source,erlang] +---- +Cookie = cow_cookie:cookie([{<<"sessionid">>, ID}]). +---- + +== See also + +link:man:cow_cookie(3)[cow_cookie(3)], +link:man:cow_cookie:parse_cookie(3)[cow_cookie:parse_cookie(3)], +link:man:cow_cookie:parse_set_cookie(3)[cow_cookie:parse_set_cookie(3)], +link:man:cow_cookie:setcookie(3)[cow_cookie:setcookie(3)] |