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
  c39acd20_0017_1382_0167_89d0da56fd74["config.go"]
  fa2b1548_5b4a_8da8_2ecf_0c2d0b098850["regexp"]
  c39acd20_0017_1382_0167_89d0da56fd74 --> fa2b1548_5b4a_8da8_2ecf_0c2d0b098850
  style c39acd20_0017_1382_0167_89d0da56fd74 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

package redirect

import (
	"regexp"

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

// Config defines the config for middleware.
type Config struct {
	// Filter defines a function to skip middleware.
	// Optional. Default: nil
	Next func(fiber.Ctx) bool

	// Rules defines the URL path rewrite rules. The values captured in asterisk can be
	// retrieved by index e.g. $1, $2 and so on.
	// Required. Example:
	// "/old":              "/new",
	// "/api/*":            "/$1",
	// "/js/*":             "/public/javascript/$1",
	// "/users/*/orders/*": "/user/$1/order/$2",
	Rules map[string]string

	rulesRegex map[*regexp.Regexp]string

	// The status code when redirecting
	// This is ignored if Redirect is disabled
	// Optional. Default: 302 Temporary Redirect
	StatusCode int
}

// ConfigDefault is the default config
var ConfigDefault = Config{
	StatusCode: fiber.StatusFound,
}

// 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.StatusCode == 0 {
		cfg.StatusCode = ConfigDefault.StatusCode
	}

	return cfg
}