aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cowboy_req.has_resp_header.asciidoc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2016-12-21 15:47:44 +0100
committerLoïc Hoguin <[email protected]>2016-12-21 15:47:44 +0100
commitba14cf783820deb52ea0a810dd457ee179d7e30d (patch)
treef71d6ffe63e46c6d0a46088beb773c5661982562 /doc/src/manual/cowboy_req.has_resp_header.asciidoc
parentf57dd51e0f233df60c670009d83fb37058b765f2 (diff)
downloadcowboy-ba14cf783820deb52ea0a810dd457ee179d7e30d.tar.gz
cowboy-ba14cf783820deb52ea0a810dd457ee179d7e30d.tar.bz2
cowboy-ba14cf783820deb52ea0a810dd457ee179d7e30d.zip
Add man pages for the reply functions
Diffstat (limited to 'doc/src/manual/cowboy_req.has_resp_header.asciidoc')
-rw-r--r--doc/src/manual/cowboy_req.has_resp_header.asciidoc54
1 files changed, 54 insertions, 0 deletions
diff --git a/doc/src/manual/cowboy_req.has_resp_header.asciidoc b/doc/src/manual/cowboy_req.has_resp_header.asciidoc
new file mode 100644
index 0000000..d6ada37
--- /dev/null
+++ b/doc/src/manual/cowboy_req.has_resp_header.asciidoc
@@ -0,0 +1,54 @@
+= cowboy_req:has_resp_header(3)
+
+== Name
+
+cowboy_req:has_resp_header - Is the given response header set?
+
+== Description
+
+[source,erlang]
+----
+has_resp_header(Name, Req :: cowboy_req:req()) -> boolean()
+
+Name :: binary() %% lowercase; case insensitive
+----
+
+Return whether the given response header has been set.
+
+The header name must be given as a lowercase binary string.
+While header names are case insensitive, Cowboy requires them
+to be given as lowercase to function properly.
+
+== Arguments
+
+Name::
+
+Header name as a lowercase binary string.
+
+Req::
+
+The Req object.
+
+== Return value
+
+A boolean indicating whether the given response header has been set.
+
+== Changelog
+
+* *1.0*: Function introduced.
+
+== Examples
+
+.Check whether the content-type header has been set
+[source,erlang]
+----
+false = cowboy_req:has_resp_header(<<"content-type">>, Req0),
+Req = cowboy_req:set_resp_header(<<"content-type">>, <<"text/html">>, Req0),
+true = cowboy_req:has_resp_header(<<"content-type">>, Req).
+----
+
+== See also
+
+link:man:cowboy_req(3)[cowboy_req(3)],
+link:man:cowboy_req:set_resp_header(3)[cowboy_req:set_resp_header(3)],
+link:man:cowboy_req:delete_resp_header(3)[cowboy_req:delete_resp_header(3)]