server

Documentation

Index

• func InCtxMiddleware(key string, value interface{}) func(http.Handler) http.Handler
• type Instance
  • func New(name string, options ...Option) *Instance
  • func (r *Instance) Folder(path string, dir fs.FS)
  • func (r *Instance) Start() error
• type Option
  • func WithHost(host string) Option
  • func WithPort(port string) Option

Functions

func InCtxMiddleware

func InCtxMiddleware(key string, value interface{}) func(http.Handler) http.Handler

InCtxMiddleware allows to specify a key/value that should be set on each request context. This is useful for services that could be used by the handlers.

Types

type Instance

type Instance struct {
	*chi.Mux
	// contains filtered or unexported fields
}

Instance of the server, it contains a router and its basic options, this instance is used to apply options to the server.

func New

func New(name string, options ...Option) *Instance

New sets up and returns a new HTTP server with routes mounted for each of the different features in this application. It also sets up the default middleware for the server.

func (*Instance) Folder

func (r *Instance) Folder(path string, dir fs.FS)

func (*Instance) Start

func (r *Instance) Start() error

type Option

type Option func(*Instance)

Allows to specify options to the server.

func WithHost

func WithHost(host string) Option

WithHost Allows to specify a host for the server to listen on.

func WithPort

func WithPort(port string) Option

WithPort Allows to specify a port for the server to listen on.