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

ExIpfs.Refs is where the commands to lookup references are defined.

To get a gist of the contents, try:

iex> ExIpfs.Refs.local()

Summary

Types

t()

A ref as reported from the refs group of commands

Functions

Get a list of all local references.

Get a list of all references from a given path.

Types

@type t() :: %ExIpfs.RefsRef{err: binary() | nil, ref: binary()}

A ref as reported from the refs group of commands

Functions

@spec local() :: {:ok, t()} | ExIpfs.Api.error_response()

Get a list of all local references.

Response is a list of ExIpfs.ref().

@spec refs(Path.t(), list()) :: ExIpfs.Api.error_response()

Get a list of all references from a given path.

Options

https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-refs