mirror of
https://github.com/ninenines/cowboy.git
synced 2025-07-16 05:00:24 +00:00
Add man pages for the parse/match/binding cowboy_req functions
This commit is contained in:
parent
bd34dfdedd
commit
7b248e5163
8 changed files with 371 additions and 7 deletions
55
doc/src/manual/cowboy_req.parse_cookies.asciidoc
Normal file
55
doc/src/manual/cowboy_req.parse_cookies.asciidoc
Normal file
|
@ -0,0 +1,55 @@
|
|||
= cowboy_req:parse_cookies(3)
|
||||
|
||||
== Name
|
||||
|
||||
cowboy_req:parse_cookies - Parse cookie headers
|
||||
|
||||
== Description
|
||||
|
||||
[source,erlang]
|
||||
----
|
||||
parse_cookies(Req) -> [{Name, Value}]
|
||||
|
||||
Name :: binary() %% case sensitive
|
||||
Value :: binary() %% case sensitive
|
||||
----
|
||||
|
||||
Parse cookie headers.
|
||||
|
||||
Alias for link:man:cowboy_req:parse_header(3)[cowboy_req:parse_header(<<"cookie">>, Req)].
|
||||
|
||||
When the cookie header is missing, `[]` is returned.
|
||||
|
||||
While an empty cookie header is not valid, some clients do
|
||||
send it. Cowboy will in this case also return `[]`.
|
||||
|
||||
== Arguments
|
||||
|
||||
Req::
|
||||
|
||||
The Req object.
|
||||
|
||||
== Return value
|
||||
|
||||
The cookies are returned as a list of key/values. Keys and
|
||||
values are case sensitive binary strings.
|
||||
|
||||
== Changelog
|
||||
|
||||
* *2.0*: Only the parsed header value is returned, it is no longer wrapped in a tuple.
|
||||
* *2.0*: Function introduced. Replaces `cookie/2,3` and `cookies/1`.
|
||||
|
||||
== Examples
|
||||
|
||||
.Look for a specific cookie
|
||||
[source,erlang]
|
||||
----
|
||||
Cookies = cowboy_req:parse_cookies(Req),
|
||||
{_, Token} = lists:keyfind(token, 1, Cookies).
|
||||
----
|
||||
|
||||
== See also
|
||||
|
||||
link:man:cowboy_req(3)[cowboy_req(3)],
|
||||
link:man:cowboy_req:parse_header(3)[cowboy_req:parse_header(3)],
|
||||
link:man:cowboy_req:match_cookies(3)[cowboy_req:match_cookies(3)]
|
Loading…
Add table
Add a link
Reference in a new issue