goconfig

README

goconfig

Documentation

Index

• func FileExists(path string) (bool, error)
• func GetCurrentDirectory() string
• func Load[T any](opts ...Option) (*T, error)
• func LoadWithDefault[T any](t *T, opts ...Option) (*T, error)
• type Option
  • func SetDefaultConfigDirs(dirs ...string) Option
  • func SetDefaultConfigFiles(files ...string) Option
  • func WithFile(path string) Option

Functions

func FileExists

func FileExists(path string) (bool, error)

FileExists checks to see if a file exist at the provided path.

func GetCurrentDirectory

func GetCurrentDirectory() string

GetCurrentDirectory return current directory

func Load

func Load[T any](opts ...Option) (*T, error)

Load config from file and env

func LoadWithDefault

func LoadWithDefault[T any](t *T, opts ...Option) (*T, error)

LoadWithDefault load config from file and env, if config file not exist, use default config

Types

type Option

type Option func(*option)

Option config option

func SetDefaultConfigDirs

func SetDefaultConfigDirs(dirs ...string) Option

Launchd doesn't set root env variables, so there is default

func SetDefaultConfigFiles

func SetDefaultConfigFiles(files ...string) Option

File names from which we attempt to read configuration.

func WithFile

func WithFile(path string) Option

WithFile set config file path