env

Documentation

Index

• Constants
• func Check()
• func Get(envKey string) string
• func IsDevelopment() bool
• func IsProduction() bool

Constants

const (
	// Required Environment Variable Keys
	BucketName     = "BUCKET_NAME"
	Region         = "REGION"
	RuntimeEnv     = "ENV"
	ServiceRoleArn = "SERVICE_ROLE_ARN"

	// Optional Environment Variable Keys
	AWSAccessKeyID     = "AWS_ACCESS_KEY_ID"
	AWSSecretAccessKey = "AWS_SECRET_ACCESS_KEY"

	// Valid values for the ENV environment variable
	RuntimeDev  = "development"
	RuntimeProd = "production"
)

Environment variable constants so that we don't keep messing stuff up

Functions

func Check

func Check()

Check ensures that the necessary environment variables are present

func Get

func Get(envKey string) string

Get returns the value of an environment variable. If it doesn't exist, it asks os.LookupEnv and caches the value.

func IsDevelopment

func IsDevelopment() bool

IsDevelopment returns whether the runtime environment is development. Specifically, it checks the value of the ENV environment variable.

func IsProduction

func IsProduction() bool

IsProduction returns whether the runtime environment is production. Specifically, it checks the value of the ENV environment variable.