static

README

static

Static file server middleware for go route

Documentation

Index

• Constants
• func New(options ...Option) route.MiddlewareFunc
• type Option
  • func Browse(browse bool) Option
  • func HTML5(html5 bool) Option
  • func Index(index string) Option
  • func Root(root string) Option
  • func Skipper(skipper route.Skipper) Option
• type Options
  • func GetDefaultOptions() Options

Constants

const (
	KB
	MB
	GB
	TB
	PB
	EB
)

Functions

func New

func New(options ...Option) route.MiddlewareFunc

New returns a Static middleware.

Types

type Option

type Option func(*Options)

func Browse

func Browse(browse bool) Option

func HTML5

func HTML5(html5 bool) Option

func Index

func Index(index string) Option

func Root

func Root(root string) Option

func Skipper

func Skipper(skipper route.Skipper) Option

type Options

type Options struct {
	// Skipper defines a function to skip middleware.
	Skipper route.Skipper

	// Root directory from where the static content is served.
	// Required.
	Root string `yaml:"root"`

	// Index file for serving a directory.
	// Optional. Default value "index.html".
	Index string `yaml:"index"`

	// Enable HTML5 mode by forwarding all not-found requests to root so that
	// SPA (single-page application) can handle the routing.
	// Optional. Default value false.
	HTML5 bool `yaml:"html5"`

	// Enable directory browsing.
	// Optional. Default value false.
	Browse bool `yaml:"browse"`
}

Options defines the config for Static middleware.

func GetDefaultOptions

func GetDefaultOptions() Options