config.go — fiber Source File

Architecture documentation for config.go, a go file in the fiber codebase. 1 imports, 0 dependents.

File go FiberCore Adapters 1 imports 2 functions 1 classes

Entity Profile

FiberCore→ Adapters→ config.go — fiber Source File

Dependency Diagram

graph LR
  c59f5e68_ee90_574c_bdad_5d34fa034955["config.go"]
  6604ba6b_bab7_17c7_e687_7d0f07080e5a["v3"]
  c59f5e68_ee90_574c_bdad_5d34fa034955 --> 6604ba6b_bab7_17c7_e687_7d0f07080e5a
  style c59f5e68_ee90_574c_bdad_5d34fa034955 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

package compress

import (
	"github.com/gofiber/fiber/v3"
)

// 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

	// Level sets the compression level used for the response
	//
	// Optional. Default: LevelDefault
	// LevelDisabled:         -1
	// LevelDefault:          0
	// LevelBestSpeed:        1
	// LevelBestCompression:  2
	Level Level
}

// Level is numeric representation of compression level
type Level int

// Represents compression level that will be used in the middleware
const (
	LevelDisabled        Level = -1
	LevelDefault         Level = 0
	LevelBestSpeed       Level = 1
	LevelBestCompression Level = 2
)

// ConfigDefault is the default config
var ConfigDefault = Config{
	Next:  nil,
	Level: LevelDefault,
}

// Helper function to set default values
func configDefault(config ...Config) Config {
	// Return default config if nothing provided
	if len(config) < 1 {
		return ConfigDefault
	}

	// Override default config
	cfg := config[0]

	// Set default values
	if cfg.Level < LevelDisabled || cfg.Level > LevelBestCompression {
		cfg.Level = ConfigDefault.Level
	}
	return cfg
}