env

README

Noob-Env

Noob Env is a tools for working with .env, such as:

• Load Env
• Get Env

Noob Env use GoDotEnv v1.4.0 to load & parse .env. Thanks to godotenv**

Contents

• Noob-Env
  • Installation
  • Quick Start & Usage

Installation

To install this package, you need to install Go (version 1.17+ is required) & initiate your Go workspace first.

1. After you initiate your workspace then you can install this package with below command.

go get -u github.com/alfarih31/nb-go-env

1. Import it in your code

import "github.com/alfarih31/nb-go-env"

Quick Start & Usage

See the test:

• env_test.go

Contributors

• Alfarih Faza alfarihfz@gmail.com

License

This project is licensed under the - see the LICENSE.md file for details

Documentation

Index

• Variables
• type ConfigServer
  • func NewDefaultConfigServer(envPath string, fallbackToWide ...bool) (ConfigServer, error)
• type Env
  • func LoadEnv(envPath string, fallbackToWide ...bool) (Env, error)
  • func LoadWithConfigServer(configServer ConfigServer) (Env, error)
• type Err
  • func NewEnvErr(s string) *Err
  • func (e *Err) Error() string
  • func (e *Err) Errorf(f string, s ...interface{}) *Err

Variables

var ErrorVarNotExist = NewEnvErr("variable not exist")

Types

type ConfigServer

type ConfigServer interface {
	Get(key string) (string, bool)
	Dump() (string, error)
}

func NewDefaultConfigServer

func NewDefaultConfigServer(envPath string, fallbackToWide ...bool) (ConfigServer, error)

type Env

type Env interface {
	GetInt(k string, def ...int) (int, error)
	MustGetInt(k string, def ...int) int
	GetString(k string, def ...string) (string, error)
	MustGetString(k string, def ...string) string
	GetBool(k string, def ...bool) (bool, error)
	MustGetBool(k string, def ...bool) bool
	GetStringArr(k string, def ...[]string) ([]string, error)
	MustGetStringArr(k string, def ...[]string) []string
	GetIntArr(k string, def ...[]int) ([]int, error)
	MustGetIntArr(k string, def ...[]int) []int
	Dump() (string, error)
}

func LoadEnv

func LoadEnv(envPath string, fallbackToWide ...bool) (Env, error)

func LoadWithConfigServer

func LoadWithConfigServer(configServer ConfigServer) (Env, error)

type Err

type Err struct {
	// contains filtered or unexported fields
}

func NewEnvErr

func NewEnvErr(s string) *Err

func (*Err) Error

func (e *Err) Error() string

func (*Err) Errorf

func (e *Err) Errorf(f string, s ...interface{}) *Err