View Source MyspaceIPFS.Config (Myspace IPFS v0.1.0)

MyspaceIPFS.Config is where the config commands of the IPFS API reside.

Link to this section Summary

Functions

Get the value of a config key.

Apply profile to config.

Replace the config with the given JSON file.

Show the current config.

Link to this section Functions

Link to this function

config(key, value \\ nil, opts \\ [])

View Source
@spec config(name(), name(), opts()) :: result()

Get the value of a config key.

parameters

Parameters

key: The key to get the value of. value: the value to set the key to (optional).

options

Options

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

[
  "bool" - <bool>, # Set a boolean value.
  "json" - <bool>, # Parse stringified JSON.
]
Link to this function

profile_apply(profile, opts \\ [])

View Source
@spec profile_apply(name(), opts()) :: result()

Apply profile to config.

parameters

Parameters

profile: The profile to apply.

options

Options

https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-config-profile-apply

[
  `dry-run` - <bool>, # Dry run.
]
@spec replace(fspath()) :: result()

Replace the config with the given JSON file.

parameters

Parameters

fspath: The path to the config file to use.

@spec show() :: result()

Show the current config.