0
Fork 0
mirror of https://github.com/ninenines/cowboy.git synced 2025-07-15 20:50:24 +00:00
cowboy/doc/src/manual/cowboy_req.has_body.asciidoc
2016-12-02 16:50:55 +01:00

45 lines
853 B
Text

= cowboy_req:has_body(3)
== Name
cowboy_req:has_body - Is there a request body?
== Description
[source,erlang]
----
has_body(Req :: cowboy_req:req()) -> boolean()
----
Return whether the request has a body.
== Arguments
Req::
The Req object.
== Return value
A boolean indicating whether the request has a body.
== Changelog
* *1.0*: Function introduced.
== Examples
.Ensure the request has a body
[source,erlang]
----
true = cowboy_req:has_body(Req).
----
== See also
link:man:cowboy_req(3)[cowboy_req(3)],
link:man:cowboy_req:body_length(3)[cowboy_req:body_length(3)],
link:man:cowboy_req:read_body(3)[cowboy_req:read_body(3)],
link:man:cowboy_req:read_urlencoded_body(3)[cowboy_req:read_urlencoded_body(3)],
link:man:cowboy_req:read_part(3)[cowboy_req:read_part(3)],
link:man:cowboy_req:read_part_body(3)[cowboy_req:read_part_body(3)]