envs

Documentation

Index

• Constants
• Variables
• func HasBilling() bool
• func IsCloud() bool
• func IsCommunity() bool
• func IsDevelopment() bool
• func IsEnterprise() bool
• func Parse[T any]() (*T, error)
• func ParseWithPrefix[T any](prefix string) (*T, error)
• type Backend

Constants

const (
	ENABLED = "true"
)

Variables

var ErrParse = errors.New("failed to parse environment variables")

var ErrParseWithPrefix = errors.New("failed to parse environment variables for the given prefix")

Functions

func HasBilling

func HasBilling() bool

HasBilling returns true if the current ShellHub server instance has billing feature enabled.

func IsCloud

func IsCloud() bool

IsCloud returns true if the current ShellHub server instance is cloud.

func IsCommunity

func IsCommunity() bool

IsCommunity return true if the current ShellHub server instance is community. It evaluates if the current ShellHub instance is neither enterprise or cloud .

func IsDevelopment

func IsDevelopment() bool

IsDevelopment returns true if the current environment is development

func IsEnterprise

func IsEnterprise() bool

IsEnterprise returns true if the current ShellHub server instance is enterprise.

func Parse

func Parse[T any]() (*T, error)

Parse parses the environment variables.

This function uses the envconfig package as its default backend, so it requires the struct to be annotated with the envconfig tags. Check the envconfig documentation for more information.

The T generic parameter must be a struct with the fields annotated with the envconfig tags, that will be returned with the values parsed from the environment variables.

func ParseWithPrefix

func ParseWithPrefix[T any](prefix string) (*T, error)

ParseWithPrefix parses the environment variables for the a given prefix.

This function uses the envconfig package as its default backend, so it requires the struct to be annotated with the envconfig tags. Check the envconfig documentation for more information.

The T generic parameter must be a struct with the fields annotated with the envconfig tags, that will be returned with the values parsed from the environment variables.

Types

type Backend

type Backend interface {
	Get(key string) string
	Process(prefix string, spec interface{}) error
}

Backend is an interface for any sort of underlying key/value store.

var DefaultBackend Backend

DefaultBackend define the backend to be used to get environment variables.