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)

Examples

• MustGet
• TryLoadDefault

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.

Example

package main

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

func main() {
	env.TryLoadDefault()
}