HTTPX v0.1.1 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.
Optimize HTTPX processors.
Performs a patch request, passing the body in the options.
Performs a patch request, passing the body in the options.
Perform a given request.
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 post request, passing the body in the options.
Encode a map as query.
Performs a request.
Link to this section Types
Specs
Link to this section Functions
Specs
delete(String.t(), keyword()) :: {:ok, HTTPX.Response.t()} | {:error, term()}
Performs a delete request.
For options see: &request/3
.
Specs
delete!(String.t(), keyword()) :: HTTPX.Response.t() | no_return()
Performs a delete request.
For options see: &delete/2
.
Specs
get(String.t(), keyword()) :: {:ok, HTTPX.Response.t()} | {:error, term()}
Performs a get request.
For options see: &request/3
.
Specs
get!(String.t(), keyword()) :: HTTPX.Response.t() | no_return()
Performs a get request.
For options see: &get/2
.
Specs
Performs a request on all IPs associated with the host DNS.
For more information see: request/3
.
Specs
optimize() :: :ok
Optimize HTTPX processors.
This is automatically called on HTTPX load. So there is no need to call it manually.
The function is idempotent, so there is no harm in calling it.
Specs
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
.
Specs
patch!(String.t(), post_body(), keyword()) :: HTTPX.Response.t() | no_return()
Performs a patch request, passing the body in the options.
For options see: &patch/3
.
Specs
perform(HTTPX.Request.t()) :: {:ok, HTTPX.Response.t()} | {:error, term()}
Perform a given request.
Specs
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
.
Specs
post!(String.t(), post_body(), keyword()) :: HTTPX.Response.t() | no_return()
Performs a post request, passing the body in the options.
For options see: &post/3
.
Specs
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
.
Specs
put!(String.t(), post_body(), keyword()) :: HTTPX.Response.t() | no_return()
Performs a post request, passing the body in the options.
For options see: &put/3
.
Specs
Encode a map as query.
Specs
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.