Packages

tesla

1.13.0
1.20.0 1.18.3 1.18.2 1.18.1 1.18.0 1.17.0 1.16.0 1.15.3 1.15.2 1.15.1 1.15.0 1.14.3 1.14.2 1.14.1 1.14.0 1.13.2 1.13.1 1.13.0 1.12.3 1.12.2 1.12.1 1.12.0 1.11.2 1.11.1 1.11.0 1.10.3 1.10.2 1.10.1 1.10.0 1.9.0 1.8.1 retired 1.8.0 1.7.0 1.6.1 1.6.0 1.5.1 1.5.0 1.4.4 1.4.3 1.4.2 1.4.1 1.4.0 1.3.3 1.3.2 1.3.1 1.3.0 1.2.1 1.2.0 1.1.0 1.0.0 1.0.0-beta.1 0.10.0 0.9.0 0.8.0 0.7.2 0.7.1 0.7.0 0.6.0 0.5.2 0.5.1 0.5.0 0.3.6 0.3.5 0.3.4 0.3.3 0.3.2 0.3.1 0.2.2 0.2.1 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

HTTP client library, with support for middleware and multiple adapters.

Security advisory: This version has known vulnerabilities. View advisories
HexDocs

Current section

Files

Jump to
Readme
75 Versions
14 Dependencies
512 Dependants
5 Advisories
Files
Activity
tesla lib tesla middleware.ex
Raw

lib/tesla/middleware.ex 

defmodule Tesla.Middleware do

  @moduledoc """

  The middleware specification.



  Middleware is an extension of basic `Tesla` functionality. It is a module that must

  implement `c:Tesla.Middleware.call/3`.



  ## Middleware options



  Options can be passed to middleware inside tuple in case of dynamic middleware

  (`Tesla.client/1`):



      Tesla.client([{Tesla.Middleware.BaseUrl, "https://example.com"}])



  ## Ordering



  The order in which middleware is defined matters. Note that the order when _sending_ the request

  matches the order the middleware was defined in, but the order when _receiving_ the response

  is reversed.



  For example, `Tesla.Middleware.DecompressResponse` must come _after_ `Tesla.Middleware.JSON`,

  otherwise the response isn't decompressed before it reaches the JSON parser.



  ## Writing custom middleware



  Writing custom middleware is as simple as creating a module implementing `c:Tesla.Middleware.call/3`.



  See `c:Tesla.Middleware.call/3` for details.



  ### Examples



      defmodule MyProject.InspectHeadersMiddleware do

        @behaviour Tesla.Middleware



        @impl true

        def call(env, next, _options) do

          IO.inspect(env.headers)



          with {:ok, env} <- Tesla.run(env, next) do

            IO.inspect(env.headers)

            {:ok, env}

          end

        end

      end

  """



  @doc """

  Invoked when a request runs.



  - (optionally) read and/or writes request data

  - calls `Tesla.run/2`

  - (optionally) read and/or writes response data



  ## Arguments



  - `env` - `Tesla.Env` struct that stores request/response data

  - `next` - middlewares that should be called after current one

  - `options` - middleware options provided by user

  """

  @callback call(env :: Tesla.Env.t(), next :: Tesla.Env.stack(), options :: any) ::

              Tesla.Env.result()

end