config

package

v0.4.4 Latest Latest Go to latest Published: Aug 24, 2020 License: MIT Imports: 7 Imported by: 0

Details

Package config providies ways to retrieve configurations and such from the user's profile.

To use this package correctly one must run

config.SetAppName("myappname")

first which sets the global appName variable.

This value is used to look up application-specific configurations, cache files, etc.

This section is empty.

This section is empty.

func CacheDir() (string, error)

CacheDir returns the user's cache dir using appName as suffix.

func Contents(file string) (io.Reader, error)

Contents returns an io.Reader with the given configuration file contents.

func Dir() (string, error)

Dir returns the user's config dir using appName as suffix.

func EnvOrContents(envar, file string) (io.Reader, error)

EnvOrContents returns the environment variable envar or configuration contents of file.

func SetAppName(name string)

SetAppName sets the global config app name which is used for retrieving specific configuration contents.

This section is empty.