assets

Documentation

Overview

Package assets serves embedded files with configurable caching and gzip compression.

Index

• func AcceptsGzip(value string) bool
• func Static(config StaticConfig) http.Handler
• type StaticConfig

Functions

func AcceptsGzip

func AcceptsGzip(value string) bool

AcceptsGzip reports whether Accept-Encoding permits gzip (or an eligible wildcard).

func Static

func Static(config StaticConfig) http.Handler

Static serves embedded files with immutable asset caching and negotiated gzip.

Types

type StaticConfig

type StaticConfig struct {
	// Files is a filesystem rooted at the public asset directory.
	Files fs.FS
	// ImmutablePrefix marks fingerprinted build assets, for example /assets/.
	ImmutablePrefix string
	// NoCacheFiles are asset paths whose content must be revalidated.
	NoCacheFiles []string
	// MinCompressSize is the minimum size for gzip, defaulting to 1024 bytes.
	MinCompressSize int
}

StaticConfig configures a read-only embedded file server.