path: root/doc
diff options
authorLoïc Hoguin <[email protected]>2017-02-19 00:26:59 +0100
committerLoïc Hoguin <[email protected]>2017-02-19 00:41:54 +0100
commit87a05a12199cc9f0a569669d96d6c65761e8ff97 (patch)
tree14c5ed70cd7750f0b82bfb60c27e67fbfdda1171 /doc
parentd8cdd9bd15e76dca3014f6f76c0ab6666b1dbda3 (diff)
Change the type of cookie name to binary()
The API will be more consistent like this, and we can ensure that duplicate cookie names are never sent.
Diffstat (limited to 'doc')
1 files changed, 2 insertions, 3 deletions
diff --git a/doc/src/manual/cowboy_req.set_resp_cookie.asciidoc b/doc/src/manual/cowboy_req.set_resp_cookie.asciidoc
index 56f308e..f4643ff 100644
--- a/doc/src/manual/cowboy_req.set_resp_cookie.asciidoc
+++ b/doc/src/manual/cowboy_req.set_resp_cookie.asciidoc
@@ -14,13 +14,11 @@ set_resp_cookie(Name, Value, Req :: cowboy_req:req())
set_resp_cookie(Name, Value, Opts, Req :: cowboy_req:req())
-> Req
-Name :: iodata() %% case sensitive
+Name :: binary() %% case sensitive
Value :: iodata() %% case sensitive
Opts :: cow_cookie:cookie_opts()
-// @todo I am not particularly happy about the fact that the name is iodata().
Set a cookie to be sent with the response.
Note that cookie names are case sensitive.
@@ -53,6 +51,7 @@ otherwise the cookie will not be sent in the response.
== Changelog
* *2.0*: `set_resp_cookie/3` introduced as an alias to `set_resp_cookie/4` with no options.
+* *2.0*: The first argument type is now `binary()` instead of `iodata()`.
* *1.0*: Function introduced.
== Examples