cowboy_req.qs.asciidoc 844 B

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. = cowboy_req:qs(3)
  2. == Name
  3. cowboy_req:qs - URI query string
  4. == Description
  5. [source,erlang]
  6. ----
  7. qs(Req :: cowboy_req:req()) -> Qs :: binary()
  8. ----
  9. Return the query string of the effective request URI.
  10. The query string can also be obtained using pattern matching:
  11. [source,erlang]
  12. ----
  13. #{qs := Qs} = Req.
  14. ----
  15. == Arguments
  16. Req::
  17. The Req object.
  18. == Return value
  19. The query string is returned as a binary string. It is case sensitive.
  20. == Changelog
  21. * *2.0*: Only the query string is returned, it is no longer wrapped in a tuple.
  22. * *1.0*: Function introduced.
  23. == Examples
  24. .Get the effective request URI's query string
  25. [source,erlang]
  26. ----
  27. Qs = cowboy_req:qs(Req).
  28. ----
  29. == See also
  30. link:man:cowboy_req(3)[cowboy_req(3)],
  31. link:man:cowboy_req:parse_qs(3)[cowboy_req:parse_qs(3)],
  32. link:man:cowboy_req:match_qs(3)[cowboy_req:match_qs(3)]