View Source MyspaceIPFS.Refs (Myspace IPFS v0.2.0-alpha.1)

MyspaceIPFS.Refs is where the main commands of the IPFS API reside.

Link to this section Summary

Types

t()

Type for the response of entries in the refs list.

Functions

Get a list of all local references.

Get a list of all references from a given path.

Link to this section Types

@type t() :: %MyspaceIPFS.Refs{Err: String.t(), Ref: String.t()}

Type for the response of entries in the refs list.

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

Link to this section Functions

@spec local() :: {:ok, any()} | MyspaceIPFS.Api.error_response()

Get a list of all local references.

Response is a list of Refs.t().

@spec refs(Path.t(), list()) :: {:ok, any()} | MyspaceIPFS.Api.error_response()

Get a list of all references from a given path.

options

Options

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