env

Documentation

Index

• func Middleware(env *Env) func(http.Handler) http.Handler
• func With(ctx context.Context, env *Env) context.Context
• type ConfigKey
• type ContextKey
• type Env
  • func Get(ctx context.Context) *Env
• type Environment

Functions

func Middleware

func Middleware(
	env *Env,
) func(http.Handler) http.Handler

Middleware returns a middleware that injects the specified Env in requests.

func With

func With(
	ctx context.Context,
	env *Env,
) context.Context

With stores the environment in the provided context.

Types

type ConfigKey

type ConfigKey string

ConfigKey is the type of a config entry key.

type ContextKey

type ContextKey string

ContextKey is the type of the key used with context to carry contextual environment.

type Env

type Env struct {
	Environment Environment
	Config      map[ConfigKey]string
}

Env is the value stored in context that stores the current environment along with configuration values.

func Get

func Get(
	ctx context.Context,
) *Env

Get returns the env currently stored in the context.

type Environment

type Environment string

Environment is the type of the possible environment values.

const (
	// Production is the production environment.
	Production Environment = "prod"
	// QA is the qa environment.
	QA Environment = "qa"
)