env

Documentation

Index

• func Get(key string) string
• func GetEnv() string
• func GetScope() string
• func IsEmptyString(value string) bool
• func IsLocal() bool
• func IsRemote() bool
• func Load() error
• func Reset()
• func SetConfig(cfg *Config)
• func SetConfigFile(configFile string)
• func SetConfigPath(configPath string)
• func SetLogger(logger *slog.Logger)
• type Config
  • func New() *Config
• type Scope
  • func (s Scope) String() string

Functions

func Get

func Get(key string) string

func GetEnv

func GetEnv() string

GetEnv Get env variable from the System. Example for test.golang-template.internal.com is test.

func GetScope

func GetScope() string

GetScope Get scope name from the System. Priority order is as follows:

-1. It looks in "app.scope" system property.
-2. If empty, it looks in ENV system env variable
	-2.1. If empty, it is a local scope
	-2.2. If not empty and starts with "test," it is a test scope
	-2.3. Otherwise, it is a "prod" environment.

func IsEmptyString

func IsEmptyString(value string) bool

func IsLocal

func IsLocal() bool

func IsRemote

func IsRemote() bool

func Load

func Load() error

Load SCOPE LOCAL (local) or REMOTE (remote) ENV DEV|UAT|REMOTE.

func Reset

func Reset()

Reset only for test.

func SetConfig

func SetConfig(cfg *Config)

SetConfig set custom config.

func SetConfigFile

func SetConfigFile(configFile string)

SetConfigFile "config.yaml" by default.

func SetConfigPath

func SetConfigPath(configPath string)

SetConfigPath "config" from root by default.

func SetLogger

func SetLogger(logger *slog.Logger)

SetLogger text warn logger by default.

Types

type Config

type Config struct {
	File   string
	Path   string
	Logger *slog.Logger
}

func New

func New() *Config

type Scope

type Scope int

const (
	LOCAL Scope = iota
	REMOTE
)

func (Scope) String

func (s Scope) String() string