Categorygithub.com/allisson/go-env
modulepackage
0.4.0
Repository: https://github.com/allisson/go-env.git
Documentation: pkg.go.dev

# README

go-env

Build Status Go Report Card go.dev reference

A simple golang library to get values from environment variables.

Example:

package main

import (
	"fmt"
	"os"

	"github.com/allisson/go-env"
)

func main() {
	// Set a environment variable
	os.Setenv("STRING", "string")
	os.Setenv("STRING_SLICE", "string1,string2,string3")
	os.Setenv("DURATION", 10, time.Seconds)

	// Get a environment variable
	str := env.GetString("STRING", "default-value")
	fmt.Printf("str=%#v\n", str)

	// Get a not set environment variable (return default value as fallback)
	str2 := env.GetString("STRING2", "default-value-for-string2")
	fmt.Printf("str2=%#v\n", str2)

	// Get a slice environment variable
	str3 := env.GetStringSlice("STRING_SLICE", ",", []string{"default-value"})
	fmt.Printf("str3=%#v\n", str3)

	duration := env.GetDuration("DURATION", 1, time.Seconds)
	fmt.Printf("duration=%v\n", duration)

	// Other functions:
	// GetInt()
	// GetIntSlice()
	// GetInt32()
	// GetInt32Slice()
	// GetInt64()
	// GetInt64Slice()
	// GetBool()
	// GetBoolSlice()
	// GetFloat32()
	// GetFloat32Slice()
	// GetFloat64()
	// GetFloat64Slice()
	// GetBytes()
}
go run main.go
str="string"
str2="default-value-for-string2"
str3=[]string{"string1", "string2", "string3"}
duration=10h0m0s

# Functions

GetBool returns a boolean value from environment variable or default value.
GetBoolSlice returns a boolean slice from environment variable or default value.
GetBytes returns a byte slice value from environment variable or default value.
GetDuration returns a time.Duration value from environment variable or default value.
GetFloat32 returns a float32 value from environment variable or default value.
GetFloat32Slice returns a float32 slice from environment variable or default value.
GetFloat64 returns a float64 value from environment variable or default value.
GetFloat64Slice returns a float64 slice from environment variable or default value.
GetInt returns a int value from environment variable or default value.
GetInt32 returns a int32 value from environment variable or default value.
GetInt32Slice returns a int32 slice from environment variable or default value.
GetInt64 returns a int64 value from environment variable or default value.
GetInt64Slice returns a int64 slice from environment variable or default value.
GetIntSlice returns a int slice from environment variable or default value.
GetString returns a string value from environment variable or default value.
GetStringSlice returns a string slice from environment variable or default value.
GetUint returns a uint value from environment variable or default value.
GetUint32 returns a uint32 value from environment variable or default value.
GetUint32Slice returns a uint32 slice from environment variable or default value.
GetUint64 returns a uint64 value from environment variable or default value.
GetUint64Slice returns a uint64 slice from environment variable or default value.
GetUintSlice returns a uint slice from environment variable or default value.