platform

Documentation

Index

• func New(opts ...fx.Option) *fx.App
• func OnCrash(interface{}, panichandler.Callstack)
• func Run(app *fx.App)
• func ServerModule(testMode bool) fx.Option
• type Config
  • func (cfg Config) Module() fx.Option
• type Platform

Functions

func New

func New(opts ...fx.Option) *fx.App

New returns a new fx.App with the provided options.

func OnCrash

func OnCrash(interface{}, panichandler.Callstack)

OnCrash is the panic handler. TODO: Crash Report will be handled by Sentry plugin. Need to implement Panic Handler for the platform.

func Run

func Run(app *fx.App)

Run is an fx helper function to gracefully start and stop an app container.

func ServerModule

func ServerModule(testMode bool) fx.Option

ServerModule returns the platform server module.

Types

type Config

type Config struct {
	// Additional config to be merged (used for unit tests etc)
	MergeConfig map[string]interface{}
	// Plugin symbols to look for
	PluginSymbols []string
}

Config is the configuration for the platform.

func (Config) Module

func (cfg Config) Module() fx.Option

Module returns the platform module.

type Platform

type Platform struct {
	// contains filtered or unexported fields
}

Platform holds the state of the platform.