config

Documentation

Overview

Package config can be used to load data to a struct which is defined by the "env" tag.

Data may come from a file and/or the os environment

Index

• func LoadFromEnvironment(target any) error
• func LoadFromFile(filename string, target any, format Format) error
• type Format

Functions

func LoadFromEnvironment

func LoadFromEnvironment(target any) error

LoadFromEnvironment loads environment data into the target struct.

target must be a pointer, otherwise it will return an error.

func LoadFromFile

func LoadFromFile(filename string, target any, format Format) error

LoadFromFile loads config from a file with the given format parser.

• filename: Path + filename of the config file
• target: target struct to load the config to (MUST be a pointer to a struct)
• format: format type (YAML or JSON)

Types

type Format

type Format int

Format defines the currently possible config file format (YAML or JSON)

const (
	YAML Format = iota
	JSON
)