0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-16 05:00:24 +00:00

Add functions for getting and setting response headers

This commit is contained in:
Johan Lövdahl 2016-11-13 15:39:40 +01:00 committed by Loïc Hoguin
parent 42c95b1584
commit 3f4e79d42f
No known key found for this signature in database
GPG key ID: 71366FF21851DF03
7 changed files with 231 additions and 1 deletions

View file

@ -0,0 +1,51 @@
= cowboy_req:set_resp_headers(3)
== Name
cowboy_req:set_resp_headers - Set several response headers
== Description
[source,erlang]
----
set_resp_headers(Headers, Req) -> cowboy_req:req()
Headers :: cowboy:http_headers()
Req :: cowboy_req:req()
----
Add all given headers to the response headers.
If a given header key already exists in the currently set
response-header map the given value will overwrite the old.
== Arguments
Headers::
A map with keys and values as binary strings.
Key values should be lowercase to function properly.
Req::
The Req object.
== Return value
A request object updated with the given response headers.
== Changelog
* *2.0*: Function introduced.
== Examples
.Get all response headers
[source,erlang]
----
Req1 = cowboy_req:set_resp_headers(#{<<"x-header-test">> => <<"1">>}, Req0).
----
== See also
link:man:cowboy_req(3)[cowboy_req(3)],
link:man:cowboy_req:resp_headers(3)[cowboy_req:resp_headers(3)]