cachecontrol

README

cache-control

cache-control middleware adds ETag header (md5 of the content) and Cache-Control header

sample usage

Using chi router, we register this middleware before a http.FileServer:

fs := http.Dir(`./assets`)
assetServer := http.FileServer(fs)
rt.Route("/assets/*", func(rt chi.Router) {
	rt.Use(cachecontrol.CacheControl(
		fs,
		cachecontrol.StripPrefix("/assets")))
	rt.Get(
		"/*",
		http.StripPrefix("/assets", assetServer).ServeHTTP)
})

TODO

• dirwatch can be used for watching directories of assets (next).
• more tests

Documentation

Index

• func CacheControl(fs http.FileSystem, options ...Option) func(http.Handler) http.Handler
• func DevelopmentMode()
• type Option
  • func IsPrivate(isPrivate bool) Option
  • func IsWeak(isWeak bool) Option
  • func MaxAge(maxAge int) Option
  • func StripPrefix(stripPrefix string) Option

Functions

func CacheControl

func CacheControl(fs http.FileSystem, options ...Option) func(http.Handler) http.Handler

CacheControl is a middleware for adding ETag and Cache-Control headers, and checks If-None-Match client header

func DevelopmentMode

func DevelopmentMode()

DevelopmentMode checks for expired entries every time.Millisecond * 10

Types

type Option

type Option func(ccoptions) ccoptions

Option .

func IsPrivate

func IsPrivate(isPrivate bool) Option

IsPrivate marks "Cache-Control" as private

func IsWeak

func IsWeak(isWeak bool) Option

IsWeak sets if the generated ETag should be a weak one

func MaxAge

func MaxAge(maxAge int) Option

MaxAge sets "max-age" in "Cache-Control" header, in seconds

func StripPrefix

func StripPrefix(stripPrefix string) Option

StripPrefix .