app

Documentation

Index

• func CustomSchema[T any](target T) ([]byte, error)
• func HasAppConfig[T any](target T) error
• func MustLoadConfigInto[T any](ctx context.Context, into T) (context.Context, T)
• func MustSetupConfigAndLogging(ctx context.Context) context.Context
• func MustSetupConfigAndLoggingInto[T any](ctx context.Context, into T) (context.Context, T)
• type App
  • func (a *App) Done() <-chan any
  • func (a *App) MustRun()
  • func (app *App) Schema() ([]byte, error)
  • func (a *App) Shutdown()

Functions

func CustomSchema

func CustomSchema[T any](target T) ([]byte, error)

Generates json schema for custom config which embeds *config.AppConfig into it Panics if no *config.AppConfig is embedded into custom config type

See swaggest/jsonschema-go for struct tag docs

func HasAppConfig

func HasAppConfig[T any](target T) error

func MustLoadConfigInto

func MustLoadConfigInto[T any](ctx context.Context, into T) (context.Context, T)

Used to unmarshal config and environment into a custom type that overloads *config.AppConfig. Will perform normal env substitutions for AppConfig, but env overrides for custom type are up to the caller.

func MustSetupConfigAndLogging

func MustSetupConfigAndLogging(ctx context.Context) context.Context

Helper function to return a context loaded up with config.AppConfig and a logger

func MustSetupConfigAndLoggingInto

func MustSetupConfigAndLoggingInto[T any](ctx context.Context, into T) (context.Context, T)

Unmarshal config into a custom type Type MUST include *config.AppConfig Stored in context as *config.AppConfig but can be asserted back

Types

type App

type App struct {
	AppContext context.Context
	HTTP       *httpopts.AppHTTP
	GRPC       *grpcopts.AppGRPC
	// contains filtered or unexported fields
}

func (*App) Done

func (a *App) Done() <-chan any

func (*App) MustRun

func (a *App) MustRun()

func (*App) Schema

func (app *App) Schema() ([]byte, error)

Generates json schema for app's config.AppConfig

func (*App) Shutdown

func (a *App) Shutdown()

Typically invoked when AppContext is done or Server has exited. Not intended to be called manually