utils

Documentation

Index

• Variables
• func BoolEnv(key string) bool
• func CalculateTimeRange(daysAgo int) (string, string)
• func EnvOrDefault(key string, fallback string) string
• func IntEnv(key string) int
• func IsAlphaNumeric(str string) bool
• func IsSensitiveEnv(str string) bool
• func QueryParamOrDefault(r *http.Request, param, fallback string) string
• func RandomString(n int) string
• func RequireEnv(key string)
• func ShortID() string
• func UIntEnv(key string) uint
• func UTCDateString() string
• func UnixToDate(u int64) string

Variables

var (
	// OneYear is the unix time for 1 year
	OneYear = time.Now().Add(time.Minute * 525600).Unix()

	OneMinMs  = "60000"
	TwoMinMs  = "120000"
	FiveMinMs = "300000"
	TenMinMs  = "600000"
)

Functions

func BoolEnv

func BoolEnv(key string) bool

BoolEnv return the boolean environment variables or false if not found

func CalculateTimeRange

func CalculateTimeRange(daysAgo int) (string, string)

CalculateTimeRange returns the start & end date from a number of days ago

func EnvOrDefault

func EnvOrDefault(key string, fallback string) string

EnvOrDefault returns and environment variable or a default value

func IntEnv

func IntEnv(key string) int

IntEnv returns the int environment variable or 0 if not found

func IsAlphaNumeric

func IsAlphaNumeric(str string) bool

func IsSensitiveEnv

func IsSensitiveEnv(str string) bool

IsSensitive returns true if an environment variable name suggests that the value "may" contain sensitive information

func QueryParamOrDefault

func QueryParamOrDefault(r *http.Request, param, fallback string) string

QueryParamOrDefault get a query parameter from an http request. Returns a default value if query param not set

func RandomString

func RandomString(n int) string

RandomString creates a random alpha-numeric string of size n

func RequireEnv

func RequireEnv(key string)

RequireEnv exits the program if environment vairables not set

func ShortID

func ShortID() string

ShortID returns a short unique identifier of length 12

func UIntEnv

func UIntEnv(key string) uint

UIntEnv returns the unsigned int environment variable or 0 if not found

func UTCDateString

func UTCDateString() string

UTCDateString returns the current date time in RFC3339 format

func UnixToDate

func UnixToDate(u int64) string

UnixToDate converts unix date into MM/DD/YYYY