Specs

body() :: iodata() | {:stream, Enumerable.t()} | nil

Optional request body.

Specs

headers() :: Mint.Types.headers()

Request headers.

Specs

method() ::
  :get | :post | :head | :patch | :delete | :options | :put | String.t()

An HTTP request method represented as an atom() or a String.t().

The following atom methods are supported: :get, :post, :put, :patch, :delete, :head, :options. You can use any arbitrary method by providing it as a String.t().

Specs

t() :: %Finch.Request{
  body: body(),
  headers: headers(),
  host: String.t() | nil,
  method: String.t(),
  path: String.t(),
  port: :inet.port_number(),
  query: String.t() | nil,
  scheme: Mint.Types.scheme(),
  unix_socket: String.t() | nil
}

Specs

url() :: String.t() | URI.t()

A Uniform Resource Locator, the address of a resource on the Web.