compress

README

http-compress

HTTP Compression middleware

Documentation

Index

• Variables
• func DefaultErrorHandler(err error, _ *http.Request, w http.ResponseWriter)
• func Handler(h http.Handler, options ...Option) http.Handler
• type EncoderFactory
• type ErrorHandler
• type Middleware
  • func New(options ...Option) Middleware
• type Option
  • func WihtoutEncoder(encoding string) Option
  • func WithAllowedTypes(list []*regexp.Regexp) Option
  • func WithEncoder(encoding string, priotity int, factory EncoderFactory) Option
  • func WithErrorHandler(handler ErrorHandler) Option
  • func WithGzip(priority, level int) Option
  • func WithMinSize(minSize uint64) Option

Variables

var DefaultAllowedTypes = []*regexp.Regexp{
	regexp.MustCompile(`^text/`),
	regexp.MustCompile(`^application/json`),
	regexp.MustCompile(`^application/javascript`),
	regexp.MustCompile(`\+(xml|json)$`),
	regexp.MustCompile(`^image/svg`),
}

Functions

func DefaultErrorHandler

func DefaultErrorHandler(err error, _ *http.Request, w http.ResponseWriter)

func Handler

func Handler(h http.Handler, options ...Option) http.Handler

Types

type EncoderFactory

type EncoderFactory func(ctx context.Context, w io.Writer) (io.WriteCloser, error)

type ErrorHandler

type ErrorHandler func(error, *http.Request, http.ResponseWriter)

type Middleware

type Middleware func(http.Handler) http.Handler

func New

func New(options ...Option) Middleware

type Option

type Option func(*config)

func WihtoutEncoder

func WihtoutEncoder(encoding string) Option

func WithAllowedTypes

func WithAllowedTypes(list []*regexp.Regexp) Option

func WithEncoder

func WithEncoder(encoding string, priotity int, factory EncoderFactory) Option

func WithErrorHandler

func WithErrorHandler(handler ErrorHandler) Option

func WithGzip

func WithGzip(priority, level int) Option

func WithMinSize

func WithMinSize(minSize uint64) Option