address

Documentation

Overview

address is a package for managing OrbitDB addresses

Index

• func IsValid(name string) error
• type Address
  • func Parse(path string) (Address, error)

Functions

func IsValid

func IsValid(name string) error

IsValid Checks if a given name is a valid address

Types

type Address

type Address interface {
	// GetRoot Returns the root CID for the store
	GetRoot() cid.Cid

	// GetRoot Returns the path for the store
	GetPath() string

	// GetRoot Returns the whole address for the store as a string
	String() string
}

Address A store address

func Parse

func Parse(path string) (Address, error)

Parse Returns an Address instance if the given path is valid