echo

Documentation

Index

• func Bundle() sen.Plugin
• type Config
• type ConfigProvider
  • func (p ConfigProvider) Initialize() error
• type Plugin
  • func (p Plugin) Initialize() error

Functions

func Bundle

func Bundle() sen.Plugin

Bundle is a sen.Plugin that provides both Config and echo.Echo for convenience.

Usage

app.With(echo.Module())

Types

type Config

type Config struct {
	Port string `env:"PORT,required" envDefault:"1323"`
}

Config includes configuration to initialize an echo server.

type ConfigProvider

type ConfigProvider struct {
	Hub sen.Hub `inject:"hub"`
}

ConfigProvider is a plugin that provides Config for initializing echo.

Usage

app.With(&echo.ConfigProvider{})

func (ConfigProvider) Initialize

func (p ConfigProvider) Initialize() error

Initialize loads Config from environment variables and registers it to the application.

type Plugin

type Plugin struct {
	Middlewares []echo.MiddlewareFunc

	// will be injected
	LC  sen.Lifecycle `inject:"lifecycle"`
	Hub sen.Hub       `inject:"hub"`
	Cfg *Config       `inject:"echo.config"`
}

Plugin is a plugin that provides an instance of echo.Echo. The plugin requires Config is registered in advance.

Usage

app.With(&echo.Plugin{
	Middlewares: middlewaresFuncs,
})

func (Plugin) Initialize

func (p Plugin) Initialize() error

Initialize initializes and registers the echo.Echo instance with the provided middlewares.