env

README

Env

The core/env package provides functionality for ensuring we retrieve an environment variable

Example

Loading default environment config

env.TryLoadDefault()

Loading default environment config together with other source

env.TryLoadDefault("package/other.env")

Expect environment variable to be set

dbURL := env.MustGet("DATABASE_URL")

Documentation

Overview

Package env provides functionality for ensuring we retrieve an environment variable

Index

• func MustGet(name string) string
• func TryLoadDefault(paths ...string)
• func TryOverloadDefault(paths ...string)

Examples

• MustGet
• TryLoadDefault
• TryOverloadDefault

Functions

func MustGet

func MustGet(name string) string

MustGet returns an environment variable by name If the requested variable does not exist, we throw a fatal error

Example

package main

import (
	"log"

	"github.com/LUSHDigital/core/env"
)

func main() {
	var dbURL = env.MustGet("DATABASE_URL")
	log.Println(dbURL)
}

func TryLoadDefault

func TryLoadDefault(paths ...string)

TryLoadDefault will attempt to load the default environment variables. This WILL NOT OVERRIDE an env variable that already exists. Those set prior to this call will remain. For env variables set in multiple files passed to this function, the FIRST one will prevail.

Example

package main

import (
	"github.com/LUSHDigital/core/env"
)

func main() {
	env.TryLoadDefault()
}

func TryOverloadDefault

func TryOverloadDefault(paths ...string)

TryOverloadDefault will attempt to load the default environment variables. This WILL OVERRIDE an env variable that already exists. Those set prior to this call will be replaced if set here. For env variables set in multiple files passed to this function, the LAST one will prevail.

Example

package main

import (
	"github.com/LUSHDigital/core/env"
)

func main() {
	env.TryOverloadDefault()
}