README
¶
Env Package Documentation
Problem Statement
The native Go library, os, retrieves environment variables with a default type of string. The env package addresses this limitation by providing a solution for retrieving environment variables in multiple data types. Additionally, it offers functionality for setting default values and checking the presence of required environment variables.
Installation
To integrate the env package into your Go project, use the following go get command:
go get -u github.com/metadiv-io/env
Supported Types
The env package supports the following data types for environment variable retrieval:
- string
- int
- int64
- int32
- int16
- int8
- float64
- float32
- uint
- uint64
- uint32
- uint16
- uint8
- bool
- complex128
- complex64
Usage
package main
import (
"fmt"
"github.com/metadiv-io/env"
)
func main() {
// Retrieve a string variable with a default value
v := env.String("STRING_VAR", "default")
// Retrieve a string variable and panic if not set
v1 := env.MustString("STRING_VAR")
// Retrieve a list of string variables with a default value
vs := env.Strings("STRING_VARS", []string{"default"})
// Retrieve a list of string variables and panic if not set
vs1 := env.MustStrings("STRING_VARS")
}
Documentation
¶
Index ¶
- func Bool(key string, defaultValue ...bool) bool
- func Bools(key string, defaultValue ...[]bool) []bool
- func Complex128(key string, defaultValue ...complex128) complex128
- func Complex128s(key string, defaultValue ...[]complex128) []complex128
- func Complex64(key string, defaultValue ...complex64) complex64
- func Complex64s(key string, defaultValue ...[]complex64) []complex64
- func Float32(key string, defaultValue ...float32) float32
- func Float32s(key string, defaultValue ...[]float32) []float32
- func Float64(key string, defaultValue ...float64) float64
- func Float64s(key string, defaultValue ...[]float64) []float64
- func Int(key string, defaultValue ...int) int
- func Int16(key string, defaultValue ...int16) int16
- func Int16s(key string, defaultValue ...[]int16) []int16
- func Int32(key string, defaultValue ...int32) int32
- func Int32s(key string, defaultValue ...[]int32) []int32
- func Int64(key string, defaultValue ...int64) int64
- func Int64s(key string, defaultValue ...[]int64) []int64
- func Int8(key string, defaultValue ...int8) int8
- func Int8s(key string, defaultValue ...[]int8) []int8
- func Ints(key string, defaultValue ...[]int) []int
- func MustBool(key string) bool
- func MustBools(key string) []bool
- func MustComplex128(key string) complex128
- func MustComplex128s(key string) []complex128
- func MustComplex64(key string) complex64
- func MustComplex64s(key string) []complex64
- func MustFloat32(key string) float32
- func MustFloat32s(key string) []float32
- func MustFloat64(key string) float64
- func MustFloat64s(key string) []float64
- func MustInt(key string) int
- func MustInt16(key string) int16
- func MustInt16s(key string) []int16
- func MustInt32(key string) int32
- func MustInt32s(key string) []int32
- func MustInt64(key string) int64
- func MustInt64s(key string) []int64
- func MustInt8(key string) int8
- func MustInt8s(key string) []int8
- func MustInts(key string) []int
- func MustString(key string) string
- func MustStrings(key string) []string
- func MustUint(key string) uint
- func MustUint16(key string) uint16
- func MustUint16s(key string) []uint16
- func MustUint32(key string) uint32
- func MustUint32s(key string) []uint32
- func MustUint64(key string) uint64
- func MustUint64s(key string) []uint64
- func MustUint8(key string) uint8
- func MustUint8s(key string) []uint8
- func MustUints(key string) []uint
- func String(key string, defaultValue ...string) string
- func Strings(key string, defaultValue ...[]string) []string
- func Uint(key string, defaultValue ...uint) uint
- func Uint16(key string, defaultValue ...uint16) uint16
- func Uint16s(key string, defaultValue ...[]uint16) []uint16
- func Uint32(key string, defaultValue ...uint32) uint32
- func Uint32s(key string, defaultValue ...[]uint32) []uint32
- func Uint64(key string, defaultValue ...uint64) uint64
- func Uint64s(key string, defaultValue ...[]uint64) []uint64
- func Uint8(key string, defaultValue ...uint8) uint8
- func Uint8s(key string, defaultValue ...[]uint8) []uint8
- func Uints(key string, defaultValue ...[]uint) []uint
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Complex128 ¶
func Complex128(key string, defaultValue ...complex128) complex128
Complex128 returns the value of the environment variable named by the key.
func Complex128s ¶
func Complex128s(key string, defaultValue ...[]complex128) []complex128
Complex128s returns the list of values of the environment variable named by the key.
func Complex64s ¶
Complex64s returns the list of values of the environment variable named by the key.
func MustBool ¶
MustBool returns the value of the environment variable named by the key. It panics if the value is empty.
func MustBools ¶
MustBools returns the list of values of the environment variable named by the key. It panics if the value is empty.
func MustComplex128 ¶
func MustComplex128(key string) complex128
MustComplex128 returns the value of the environment variable named by the key. It panics if the value is empty.
func MustComplex128s ¶
func MustComplex128s(key string) []complex128
MustComplex128s returns the list of values of the environment variable named by the key. It panics if the value is empty.
func MustComplex64 ¶
MustComplex64 returns the value of the environment variable named by the key. It panics if the value is empty.
func MustComplex64s ¶
MustComplex64s returns the list of values of the environment variable named by the key. It panics if the value is empty.
func MustFloat32 ¶
MustFloat32 returns the value of the environment variable named by the key. It panics if the value is empty.
func MustFloat32s ¶
MustFloat32s returns the list of values of the environment variable named by the key. It panics if the value is empty.
func MustFloat64 ¶
MustFloat64 returns the value of the environment variable named by the key. It panics if the value is empty.
func MustFloat64s ¶
MustFloat64s returns the list of values of the environment variable named by the key. It panics if the value is empty.
func MustInt ¶
MustInt returns the value of the environment variable named by the key. It panics if the value is empty.
func MustInt16 ¶
MustInt16 returns the value of the environment variable named by the key. It panics if the value is empty.
func MustInt16s ¶
MustInt16s returns the list of values of the environment variable named by the key. It panics if the value is empty.
func MustInt32 ¶
MustInt32 returns the value of the environment variable named by the key. If the value is empty, it will panic.
func MustInt32s ¶
MustInt32s returns the value of the environment variable named by the key. If the value is empty, it will panic.
func MustInt64 ¶
MustInt64 returns the value of the environment variable named by the key. It panics if the value is empty.
func MustInt64s ¶
MustInt64s returns the list of values of the environment variable named by the key. It panics if the value is empty.
func MustInt8 ¶
MustInt8 returns the value of the environment variable named by the key. It panics if the value is empty.
func MustInt8s ¶
MustInt8s returns the list of values of the environment variable named by the key. It panics if the value is empty.
func MustInts ¶
MustInts returns the list of values of the environment variable named by the key. It panics if the value is empty.
func MustString ¶
MustString returns the value of the environment variable named by the key. It panics if the value is empty.
func MustStrings ¶
MustStrings returns the list of values of the environment variable named by the key. It panics if the value is empty.
func MustUint ¶
MustUint returns the value of the environment variable named by the key. It panics if the value is empty.
func MustUint16 ¶
MustUint16 returns the value of the environment variable named by the key. It panics if the value is empty.
func MustUint16s ¶
MustUint16s returns the list of values of the environment variable named by the key. It panics if the value is empty.
func MustUint32 ¶
MustUint32 returns the value of the environment variable named by the key. It panics if the value is empty.
func MustUint32s ¶
MustUint32s returns the list of values of the environment variable named by the key. It panics if the value is empty.
func MustUint64 ¶
MustUint64 returns the value of the environment variable named by the key. It panics if the value is empty.
func MustUint64s ¶
MustUint64s returns the list of values of the environment variable named by the key. It panics if the value is empty.
func MustUint8 ¶
MustUint8 returns the value of the environment variable named by the key. It panics if the value is empty.
func MustUint8s ¶
MustUint8s returns the list of values of the environment variable named by the key. It panics if the value is empty.
func MustUints ¶
MustUints returns the list of values of the environment variable named by the key. It panics if the value is empty.
Types ¶
This section is empty.
Source Files
Directories