From faca7866ed1c59cd41e11fcfc5a9f95378380497 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Sat, 5 Nov 2016 14:17:30 +0200 Subject: Partially update manual for the cowboy_req Only the access functions have been modified so far. --- doc/src/manual/cowboy_req.qs.asciidoc | 50 +++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 doc/src/manual/cowboy_req.qs.asciidoc (limited to 'doc/src/manual/cowboy_req.qs.asciidoc') diff --git a/doc/src/manual/cowboy_req.qs.asciidoc b/doc/src/manual/cowboy_req.qs.asciidoc new file mode 100644 index 0000000..6e92357 --- /dev/null +++ b/doc/src/manual/cowboy_req.qs.asciidoc @@ -0,0 +1,50 @@ += cowboy_req:qs(3) + +== Name + +cowboy_req:qs - URI query string + +== Description + +[source,erlang] +---- +qs(Req :: cowboy_req:req()) -> Qs :: binary() +---- + +Return the query string of the effective request URI. + +The query string can also be obtained using pattern matching: + +[source,erlang] +---- +#{qs := Qs} = Req. +---- + +== Arguments + +Req:: + +The Req object. + +== Return value + +The query string is returned as a binary string. It is case sensitive. + +== Changelog + +* *2.0*: Only the query string is returned, it is no longer wrapped in a tuple. +* *1.0*: Function introduced. + +== Examples + +.Get the effective request URI's query string +[source,erlang] +---- +Qs = cowboy_req:qs(Req). +---- + +== See also + +link:man:cowboy_req(3)[cowboy_req(3)], +link:man:cowboy_req:parse_qs(3)[cowboy_req:parse_qs(3)], +link:man:cowboy_req:match_qs(3)[cowboy_req:match_qs(3)] -- cgit v1.2.3