mirror of
https://github.com/ninenines/cowboy.git
synced 2025-07-16 05:00:24 +00:00
Add man pages for the parse/match/binding cowboy_req functions
This commit is contained in:
parent
bd34dfdedd
commit
7b248e5163
8 changed files with 371 additions and 7 deletions
46
doc/src/manual/cowboy_req.bindings.asciidoc
Normal file
46
doc/src/manual/cowboy_req.bindings.asciidoc
Normal file
|
@ -0,0 +1,46 @@
|
|||
= cowboy_req:bindings(3)
|
||||
|
||||
== Name
|
||||
|
||||
cowboy_req:bindings - Access all values bound from the route
|
||||
|
||||
== Description
|
||||
|
||||
[source,erlang]
|
||||
----
|
||||
bindings(Req :: cowboy_req:req()) -> [{Name :: atom(), any()}]
|
||||
----
|
||||
|
||||
Return all bindings as a list of key/value pairs.
|
||||
|
||||
== Arguments
|
||||
|
||||
Req::
|
||||
|
||||
The Req object.
|
||||
|
||||
== Return value
|
||||
|
||||
By default values are case sensitive binary strings, however
|
||||
constraints may change the type of this value (for example
|
||||
automatically converting numbers to integer).
|
||||
|
||||
== Changelog
|
||||
|
||||
* *2.0*: Only the values are returned, it is no longer wrapped in a tuple.
|
||||
* *1.0*: Function introduced.
|
||||
|
||||
== Examples
|
||||
|
||||
.Get all bindings
|
||||
[source,erlang]
|
||||
----
|
||||
Bindings = cowboy_req:bindings(Req).
|
||||
----
|
||||
|
||||
== See also
|
||||
|
||||
link:man:cowboy_req(3)[cowboy_req(3)],
|
||||
link:man:cowboy_req:binding(3)[cowboy_req:binding(3)],
|
||||
link:man:cowboy_req:host_info(3)[cowboy_req:host_info(3)],
|
||||
link:man:cowboy_req:path_info(3)[cowboy_req:path_info(3)]
|
Loading…
Add table
Add a link
Reference in a new issue