config

Documentation

Overview

config contains the loggic around config files for Armaria. The config file is a simple toml file.

Index

• Variables
• func UpdateConfig(folderPath string, configPath string, update UpdateConfigCallback) error
• type Config
  • func GetConfig(configPath string) (Config, error)
• type UpdateConfigCallback

Variables

var ErrConfigMissing = errors.New("config missing")

ErrConfigMissing is returned when the config file is missing.

Functions

func UpdateConfig

func UpdateConfig(folderPath string, configPath string, update UpdateConfigCallback) error

UpdateConfig updates the current config. It will be created if it hasn't already been created.

Types

type Config

type Config struct {
	DB string `koanf:"db"`
}

Config is the configuration for Armaria.

func GetConfig

func GetConfig(configPath string) (Config, error)

GetConfig gets the current config. If the sentinel error ErrConfigMissing then it doesn't exist.

type UpdateConfigCallback

type UpdateConfigCallback func(config *Config)

UpdateConfigCallback is a callback to update the current config