ginx

Documentation

Index

• func DirHandler(fileSystem http.FileSystem, options DirOptions) gin.HandlerFunc
• func HandleSPA(engine *gin.Engine, options SPAOptions) gin.HandlerFunc
• func NewSPAHandler(root string, embeddedFS fs.FS, embeddedRoot string, options DirOptions) gin.HandlerFunc
• func StaticFiles(root string) http.FileSystem
• type DirOptions
• type SPAOptions

Functions

func DirHandler

func DirHandler(fileSystem http.FileSystem, options DirOptions) gin.HandlerFunc

func HandleSPA

func HandleSPA(engine *gin.Engine, options SPAOptions) gin.HandlerFunc

func NewSPAHandler

func NewSPAHandler(root string, embeddedFS fs.FS, embeddedRoot string, options DirOptions) gin.HandlerFunc

func StaticFiles

func StaticFiles(root string) http.FileSystem

Types

type DirOptions

type DirOptions struct {
	ShowList  bool
	SPA       bool
	IndexName string
}

type SPAOptions

type SPAOptions struct {
	Root             string
	EmbeddedFS       fs.FS
	EmbeddedRoot     string
	DirOptions       DirOptions
	NotFoundPrefixes []string
	NotFoundHandler  gin.HandlerFunc
}