router

Documentation

Index

• func New(opts ...Config) http.Handler
• type Config
  • func WithConfig(c *config.Config) Config
  • func WithDatabase(db persistence.Service) Config
  • func WithEmails(t *template.Template) Config
  • func WithFS(fs http.FileSystem) Config
  • func WithLogger(l *logrus.Logger) Config
  • func WithMailer(m mailer.Mailer) Config
  • func WithTemplate(t *template.Template) Config

Functions

func New

func New(opts ...Config) http.Handler

New creates a new application router that reads and writes data to the given database implementation. In the context of the application this expects to be the only top level router in charge of handling all incoming HTTP requests.

Types

type Config

type Config func(*router)

Config adds a configuration value to the router

func WithConfig

func WithConfig(c *config.Config) Config

WithConfig attaches the given runtime config to the router.

func WithDatabase

func WithDatabase(db persistence.Service) Config

WithDatabase sets the database the router will use

func WithEmails

func WithEmails(t *template.Template) Config

WithEmails ensures the router is using the given template object for rendering email output.

func WithFS

func WithFS(fs http.FileSystem) Config

WithFS attaches a filesystem for serving static assets

func WithLogger

func WithLogger(l *logrus.Logger) Config

WithLogger sets the logger the router will use

func WithMailer

func WithMailer(m mailer.Mailer) Config

WithMailer attaches a mailer for sending transactional email

func WithTemplate

func WithTemplate(t *template.Template) Config

WithTemplate ensures the router is using the given template object for rendering dynamic HTML output.