helpers

Documentation

Index

• func OptionalEnv(name string) string
• func OptionalEnvOrDefault(name, defaultValue string) string
• func RequireEnv(name string) (string, error)

Functions

func OptionalEnv

func OptionalEnv(name string) string

OptionalEnv returns the value for environment variable if it exists, otherwise returns an empty string.

func OptionalEnvOrDefault

func OptionalEnvOrDefault(name, defaultValue string) string

OptionalEnvOrDefault returns the value for environment variable if it exists, otherwise returns the default value.

func RequireEnv

func RequireEnv(name string) (string, error)

RequireEnv requires environment variable to be present. The constraint can be verified only during execution of the workspace build (determined with env `CODER_WORKSPACE_BUILD_ID`).