README
¶
getenv
Package getenv provides functionality for loading environment variables and parse them into go builtin types.
Types supported:
- string
- []string
- int
- []int
- int8
- []int8
- int16
- []int16
- int32
- []int32
- int64
- []int64
- uint8
- []uint8
- uint16
- []uint16
- uint64
- []uint64
- uint
- []uint
- uintptr
- []uintptr
- uint32
- []uint32
- float32
- []float32
- float64
- []float64
- time.Time
- []time.Time
- time.Duration
- []time.Duration
- bool
- []bool
- url.URL
- []url.URL
- net.IP
- []net.IP
- complex64
- []complex64
- complex128
- []complex128
Examples
EnvOrDefault
EnvOrDefault retrieves the value of the environment variable named by the key. If the variable is present in the environment the value will be parsed and returned. Otherwise, the default value will be returned.
package main
import (
"fmt"
"net"
"net/url"
"os"
"time"
"github.com/obalunenko/getenv"
"github.com/obalunenko/getenv/option"
)
func main() {
key := "GH_GETENV_TEST"
defer func() {
if err := os.Unsetenv("GH_GETENV_TEST"); err != nil {
panic(err)
}
}()
var val any
// string
if err := os.Setenv(key, "golly"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, "golly")
fmt.Printf("[%T]: %v\n", val, val)
// int
if err := os.Setenv(key, "123"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, -99)
fmt.Printf("[%T]: %v\n", val, val)
// time.Time
if err := os.Setenv(key, "2022-01-20"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key,
time.Date(1992, 12, 1, 0, 0, 0, 0, time.UTC),
option.WithTimeLayout("2006-01-02"),
)
fmt.Printf("[%T]: %v\n", val, val)
// []float64
if err := os.Setenv(key, "26.89,0.67"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, []float64{-99},
option.WithSeparator(","),
)
fmt.Printf("[%T]: %v\n", val, val)
// time.Duration
if err := os.Setenv(key, "2h35m"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, time.Second)
fmt.Printf("[%T]: %v\n", val, val)
// url.URL
if err := os.Setenv(key, "https://test:abcd123@golangbyexample.com:8000/tutorials/intro?type=advance&compact=false#history"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, url.URL{})
fmt.Printf("[%T]: %v\n", val, val)
// net.IP
if err := os.Setenv(key, "2001:cb8::17"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, net.IP{})
fmt.Printf("[%T]: %v\n", val, val)
// []string
if err := os.Setenv(key, "a,b,c,d"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, []string{}, option.WithSeparator(","))
fmt.Printf("[%T]: %v\n", val, val)
// complex128
if err := os.Setenv(key, "1+2i"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, complex128(0))
fmt.Printf("[%T]: %v\n", val, val)
// []complex64
if err := os.Setenv(key, "1+2i,3+4i"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, []complex64{}, option.WithSeparator(","))
fmt.Printf("[%T]: %v\n", val, val)
}
Output:
[string]: golly
[int]: 123
[time.Time]: 2022-01-20 00:00:00 +0000 UTC
[[]float64]: [26.89 0.67]
[time.Duration]: 2h35m0s
[url.URL]: {https test:abcd123 golangbyexample.com:8000 /tutorials/intro false false type=advance&compact=false history }
[net.IP]: 2001:cb8::17
[[]string]: [a b c d]
[complex128]: (1+2i)
[[]complex64]: [(1+2i) (3+4i)]
Documentation
¶
Overview ¶
Package getenv provides functionality for loading environment variables and parse them into go builtin types.
Types supported: - string - []string - int - []int - int8 - []int8 - int16 - []int16 - int32 - []int32 - int64 - []int64 - uint8 - []uint8 - uint16 - []uint16 - uint64 - []uint64 - uint - []uint - uintptr - []uintptr - uint32 - []uint32 - float32 - []float32 - float64 - []float64 - time.Time - []time.Time - time.Duration - []time.Duration - bool - []bool - url.URL - []url.URL - net.IP - []net.IP - complex64 - []complex64 - complex128 - []complex128
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EnvOrDefault ¶ added in v1.2.0
func EnvOrDefault[T internal.EnvParsable](key string, defaultVal T, options ...option.Option) T
EnvOrDefault retrieves the value of the environment variable named by the key. If the variable is present in the environment the value will be parsed and returned. Otherwise, the default value will be returned.
Example ¶
package main
import (
"fmt"
"net"
"net/url"
"os"
"time"
"github.com/obalunenko/getenv"
"github.com/obalunenko/getenv/option"
)
func main() {
key := "GH_GETENV_TEST"
defer func() {
if err := os.Unsetenv("GH_GETENV_TEST"); err != nil {
panic(err)
}
}()
var val any
// string
if err := os.Setenv(key, "golly"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, "golly")
fmt.Printf("[%T]: %v\n", val, val)
// int
if err := os.Setenv(key, "123"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, -99)
fmt.Printf("[%T]: %v\n", val, val)
// time.Time
if err := os.Setenv(key, "2022-01-20"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key,
time.Date(1992, 12, 1, 0, 0, 0, 0, time.UTC),
option.WithTimeLayout("2006-01-02"),
)
fmt.Printf("[%T]: %v\n", val, val)
// []float64
if err := os.Setenv(key, "26.89,0.67"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, []float64{-99},
option.WithSeparator(","),
)
fmt.Printf("[%T]: %v\n", val, val)
// time.Duration
if err := os.Setenv(key, "2h35m"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, time.Second)
fmt.Printf("[%T]: %v\n", val, val)
// url.URL
if err := os.Setenv(key, "https://test:abcd123@golangbyexample.com:8000/tutorials/intro?type=advance&compact=false#history"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, url.URL{})
fmt.Printf("[%T]: %v\n", val, val)
// net.IP
if err := os.Setenv(key, "2001:cb8::17"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, net.IP{})
fmt.Printf("[%T]: %v\n", val, val)
// []string
if err := os.Setenv(key, "a,b,c,d"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, []string{}, option.WithSeparator(","))
fmt.Printf("[%T]: %v\n", val, val)
// complex128
if err := os.Setenv(key, "1+2i"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, complex128(0))
fmt.Printf("[%T]: %v\n", val, val)
// []complex64
if err := os.Setenv(key, "1+2i,3+4i"); err != nil {
panic(err)
}
val = getenv.EnvOrDefault(key, []complex64{}, option.WithSeparator(","))
fmt.Printf("[%T]: %v\n", val, val)
}
Output: [string]: golly [int]: 123 [time.Time]: 2022-01-20 00:00:00 +0000 UTC [[]float64]: [26.89 0.67] [time.Duration]: 2h35m0s [url.URL]: {https test:abcd123 golangbyexample.com:8000 /tutorials/intro false false type=advance&compact=false history } [net.IP]: 2001:cb8::17 [[]string]: [a b c d] [complex128]: (1+2i) [[]complex64]: [(1+2i) (3+4i)]
Types ¶
This section is empty.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package internal provides internal implementation logic for environment variables parsing.
|
Package internal provides internal implementation logic for environment variables parsing. |
|
Package option provides options for parsing environment variables.
|
Package option provides options for parsing environment variables. |
Click to show internal directories.
Click to hide internal directories.