config

package

v1.9.1 Latest Latest Go to latest Published: Apr 4, 2024 License: MPL-2.0 Imports: 6 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func DeleteDataString(relPath string) error

DeleteDataString deletes a file in the data home directory

func GetValue(key string) (string, error)

GetValue reads the value of a config key from the config file

func ReadDataString(relPath string) (string, error)

ReadDataString reads a string from a file in the data home directory

func SaveDataString(relPath string, data string) error

SaveDataString saves a string to a file in the data home directory

func SetConfigHome(configDir string) error

SetConfigHome sets the configuration home directory - useful for testing

func SetDataHome(dataHome string) error

SetDataHome sets the data home directory - useful for testing

func SetValue(key, val string) error

SetValue updates the value of a config key in the config file

func UnsetConfigHome() error

UnsetConfigHome unsets the configuration home directory returning to the default value

func UnsetDataHome() error

UnsetDataHome unsets the data home directory returning to the default value

func UnsetValue(key string) error

UnsetValue removes the value of a config key from the config file

This section is empty.