cachecontrol

Documentation

Overview

Package cachecontrol creates a cache control echo middleware

Index

• Variables
• func New() echo.MiddlewareFunc
• func NewWithConfig(config Config) echo.MiddlewareFunc
• type Config

Variables

var DefaultConfig = Config{
	Skipper: middleware.DefaultSkipper,
	NoCacheHeaders: map[string]string{
		"Expires":         epoch,
		"Cache-Control":   "no-cache, private, max-age=0",
		"Pragma":          "no-cache",
		"X-Accel-Expires": "0",
	},
	EtagHeaders: []string{
		"ETag",
		"If-Modified-Since",
		"If-Match",
		"If-None-Match",
		"If-Range",
		"If-Unmodified-Since",
	},
}

DefaultConfig is the default configuration of the middleware

Functions

func New

func New() echo.MiddlewareFunc

New creates a new middleware function with the default config

func NewWithConfig

func NewWithConfig(config Config) echo.MiddlewareFunc

NewWithConfig returns a new router middleware handler

Types

type Config

type Config struct {
	Enabled bool `json:"enabled" koanf:"enabled" default:"true"`
	// Skipper defines a function to skip middleware
	Skipper middleware.Skipper `json:"-" koanf:"-"`
	// noCacheHeaders is the header <-> match map pair to match in http for entity headers to remove
	NoCacheHeaders map[string]string `json:"noCacheHeaders" koanf:"noCacheHeaders"`
	// etagHeaders is the string of entity headers to remove
	EtagHeaders []string `json:"etagHeaders" koanf:"etagHeaders"`
}

Config is the config values for the cache-control middleware