View Source MyspaceIPFS.Api (Myspace IPFS v0.2.0-alpha.2)

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

Link to this section Summary

Types

A structured error returned from the upstream IPFS API.

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

A type that represents the possible responses from the API.

Link to this section Types

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

A structured error returned from the upstream IPFS API.

@type error_response() ::
  {:error, error()} | {:error, Tesla.Env.t()} | {:error, atom()}

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

@type response() :: binary() | map() | list() | error_response()

A type that represents the possible responses from the API.