web

package module

v0.0.0-...-feaa6dc Latest Latest Go to latest Published: Sep 13, 2021 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This package implements an HTTP server that other web-based Jaunty services inherit from.

Package web implements an HTTP server as a basis for web-based services.

This section is empty.

View Source

var ErrInvalidOption = errors.New("web: invalid option given")

ErrInvalidOption is returned when a configuration option is not set or otherwise invalid.

This section is empty.

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

Server is a barebones HTTP server.

func New(addr string) (*Server, error)

New creates a new Server from the given Options.

func (s *Server) Start(ctx context.Context, so ...StartOption) error

Start registers the given router as a server handler and begins to listen on the configured address.

Start adds a *zap.Logger onto the given context for use in request-scoped logging.

type StartOption func(*startParams)

StartOption sets start parameters on a *Server.

func Logger(l *zap.Logger) StartOption

func Router(r *chi.Mux) StartOption