env

package

v0.0.0-...-707188c Latest Latest Go to latest Published: Apr 26, 2024 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ainsleydev/webkit

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func AppEnvironment() string
func Get(key, fallback string) string
func GetOrError(key string) (string, error)
func IsDevelopment() bool
func IsProduction() bool
func IsStaging() bool
func ParseConfig(cfg any, filenames ...string) error

Constants ¶

View Source

const (
	// Development env definition.
	Development string = "development"
	// Staging env definition.
	Staging = "staging"
	// Production env definition.
	Production = "production"
)

Variables ¶

This section is empty.

Functions ¶

func AppEnvironment ¶

func AppEnvironment() string

AppEnvironment returns the app environment.

func Get ¶

func Get(key, fallback string) string

Get provides a default override for environment vars as a second argument.

func GetOrError ¶

func GetOrError(key string) (string, error)

GetOrError will attempt to get the value from the environment variable and return an error if not available.

func IsDevelopment ¶

func IsDevelopment() bool

IsDevelopment returns whether we are running the app in development.

func IsProduction ¶

func IsProduction() bool

IsProduction returns whether we are running the app in production.

func IsStaging ¶

func IsStaging() bool

IsStaging returns whether we are running the app in staging.

func ParseConfig ¶

func ParseConfig(cfg any, filenames ...string) error

ParseConfig loads the environment variables from the .env file and parses the environment variables into the provided struct. It returns an error if the .env file cannot be loaded or if the environment variables cannot be parsed.

Types ¶

This section is empty.

Source Files ¶

View all Source files

env.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL