HTTPX v0.0.12 HTTPX View Source
Simple HTTP(s) client with integrated auth methods.
Link to this section Summary
Functions
Performs a delete request
Performs a delete request
Performs a get request
Performs a get request
Performs a request on all IPs associated with the host DNS
Performs a patch request, passing the body in the options
Performs a patch request, passing the body in the options
Performs a post request, passing the body in the options
Performs a post request, passing the body in the options
Performs a post request, passing the body in the options
Performs a put request, passing the body in the options
Performs a request
Link to this section Types
Link to this section Functions
delete!(String.t(), keyword()) :: HTTPX.Response.t()
Performs a delete request.
For options see: &delete/2
.
delete(String.t(), keyword()) :: {:ok, HTTPX.Response.t()} | {:error, term()}
Performs a delete request.
For options see: &request/3
.
get!(String.t(), keyword()) :: HTTPX.Response.t()
Performs a get request.
For options see: &get/2
.
get(String.t(), keyword()) :: {:ok, HTTPX.Response.t()} | {:error, term()}
Performs a get request.
For options see: &request/3
.
Performs a request on all IPs associated with the host DNS.
For more information see: request/3
.
patch!(String.t(), post_body(), keyword()) :: HTTPX.Response.t()
Performs a patch request, passing the body in the options.
For options see: &patch/3
.
patch(String.t(), post_body(), keyword()) :: {:ok, HTTPX.Response.t()} | {:error, term()}
Performs a patch request, passing the body in the options.
For options see: &request/3
.
post!(String.t(), post_body(), keyword()) :: HTTPX.Response.t()
Performs a post request, passing the body in the options.
For options see: &post/3
.
post(String.t(), post_body(), keyword()) :: {:ok, HTTPX.Response.t()} | {:error, term()}
Performs a post request, passing the body in the options.
For options see: &request/3
.
put!(String.t(), post_body(), keyword()) :: HTTPX.Response.t()
Performs a post request, passing the body in the options.
For options see: &put/3
.
put(String.t(), post_body(), keyword()) :: {:ok, HTTPX.Response.t()} | {:error, term()}
Performs a put request, passing the body in the options.
For options see: &request/3
.
request(term(), String.t(), keyword()) :: {:ok, HTTPX.Response.t()} | {:error, term()}
Performs a request.
The given method
is used and the url
is called.
The following options can be set:
:body
, the body to send with the request.:params
, a map containing query params.:headers
, list of header tuples.:settings
, options to pass along to:hackney
.:fail
, will error out any request with a non 2xx response code, when set to true.:auth
, set authorization options.:format
, set to parse. (Like:json
):retry
, set to retry the request. See the retry options.