Compress

Search…
Compress
Compression middleware for Fiber that will compress the response using gzip, deflate and brotli compression depending on the Accept-Encoding header.
​Signatures​
​Examples​
​Config​
​Default Config​
​Constants​
Signatures
func New(config ...Config) fiber.Handler
Examples
Import the middleware package that is part of the Fiber web framework
import (
  "github.com/gofiber/fiber/v2"
  "github.com/gofiber/fiber/v2/middleware/compress"
)
After you initiate your Fiber app, you can use the following possibilities:
// Default middleware 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
}))
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
}
Default Config
var ConfigDefault = Config{
    Next:  nil,
    Level: LevelDefault,
}
Constants
// Compression levels
const (
    LevelDisabled        = -1
    LevelDefault         = 0
    LevelBestSpeed       = 1
    LevelBestCompression = 2
)
Cache
CORS
Last modified 1yr ago
Copy link
On this page
Signatures
Examples
Config
Default Config
Constants