View Source ExIpfs.Api (Elixir IPFS v0.1.7)

A module that contains the functions that are used to interact with the IPFS API.

Summary

Types

error()

A structured error returned from the upstream IPFS API.

error_response()

A an aggregate type that represents the possible errors that can be returned from the API.

response()

A type that represents the possible responses from the API.

Types

error()

@type error() :: %ExIpfs.ApiError{code: integer(), message: binary(), type: binary()}

A structured error returned from the upstream IPFS API.

error_response()

@type error_response() ::
  {:error,
   atom()
   | %{
       :__struct__ => ExIpfs.ApiError | Tesla.Env,
       optional(:__client__) => Tesla.Client.t(),
       optional(:__module__) => atom(),
       optional(:body) => any(),
       optional(:code) => integer(),
       optional(:headers) => [{any(), any()}],
       optional(:message) => binary(),
       optional(:method) =>
         :delete | :get | :head | :options | :patch | :post | :put | :trace,
       optional(:opts) => [{any(), any()}],
       optional(:query) => [{any(), any()}],
       optional(:status) => nil | integer(),
       optional(:type) => binary(),
       optional(:url) => binary()
     }}

A an aggregate type that represents the possible errors that can be returned from the API.

response()

@type response() :: binary() | map() | list() | error_response() | Tesla.Env.t()

A type that represents the possible responses from the API.