aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/manual/cowboy_req.has_body.asciidoc
blob: 5e985b141daa047cb9fb323be5e97efca9f296ad (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
= 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)]