systemfx

Documentation

Index

• Variables
• func RegisterHealthCheck(p RegisterRouteParams)
• type Params
• type RegisterRouteParams
• type Result
  • func New(p Params) (Result, error)

Variables

var Module = fx.Options(fx.Provide(New), fx.Invoke(RegisterHealthCheck))

Module starts an HTTP server and returns a http.ServeMux to use to register handlers for the server.

Functions

func RegisterHealthCheck

func RegisterHealthCheck(p RegisterRouteParams)

Types

type Params

type Params struct {
	fx.In

	Lifecycle  fx.Lifecycle
	Shutdowner fx.Shutdowner
	Logger     *zap.Logger
}

Params defines the dependencies of the httpfx module.

type RegisterRouteParams

type RegisterRouteParams struct {
	fx.In

	Mux *http.ServeMux `name:"system"`
}

type Result

type Result struct {
	fx.Out

	Mux *http.ServeMux `name:"system"`
}

Result defines the objects that the httpfx module provides.

func New

func New(p Params) (Result, error)

New exports functionality similar to Module, but allows the caller to wrap or modify Result. Most users should use Module instead.