README

Compress

Compression middleware for Fiber that will compress the response using gzip, deflate and brotli compression depending on the Accept-Encoding header.

Signatures
func New(config ...Config) fiber.Handler
Config
// Config defines the config for middleware.
type Config struct {
	// Next defines a function to skip this middleware when returned true.
	//
	// Optional. Default: nil
	Next func(c *fiber.Ctx) bool

	// CompressLevel determines the compression algoritm
	//
	// Optional. Default: LevelDefault
	// LevelDisabled:         -1
	// LevelDefault:          0
	// LevelBestSpeed:        1
	// LevelBestCompression:  2
	Level int
}

Constants
// Compression levels
const (
	LevelDisabled        = -1
	LevelDefault         = 0
	LevelBestSpeed       = 1
	LevelBestCompression = 2
)
Example

Import the compress package that is part of the Fiber web framework

import (
  "github.com/gofiber/fiber"
  "github.com/gofiber/fiber/middleware/compress"
)

After you initiate your Fiber app, you can use the following possibilities:

// Default compression config
app.Use(compress.New())

// Provide a custom compression level
app.Use(compress.New(compress.Config{
    Level: compress.LevelBestSpeed, // 1
}))

// Skip middleware for specific routes
app.Use(compress.New(compress.Config{
  Next:  func(c *fiber.Ctx) bool {
    return c.Path() == "/dont_compress"
  },
  Level: compress.LevelBestSpeed, // 1
}))
Expand ▾ Collapse ▴

Documentation

Index

Constants

View Source
const (
	LevelDisabled        = -1
	LevelDefault         = 0
	LevelBestSpeed       = 1
	LevelBestCompression = 2
)

    Compression levels

    Variables

    View Source
    var ConfigDefault = Config{
    	Next:  nil,
    	Level: LevelDefault,
    }

      ConfigDefault is the default config

      Functions

      func New

      func New(config ...Config) fiber.Handler

        New creates a new middleware handler

        Types

        type Config

        type Config struct {
        	// Next defines a function to skip this middleware when returned true.
        	//
        	// Optional. Default: nil
        	Next func(c *fiber.Ctx) bool
        
        	// CompressLevel determines the compression algoritm
        	//
        	// Optional. Default: LevelDefault
        	// LevelDisabled:         -1
        	// LevelDefault:          0
        	// LevelBestSpeed:        1
        	// LevelBestCompression:  2
        	Level int
        }

          Config defines the config for middleware.

          Source Files