github.com/gofiber/fiber/v2@v2.47.0/middleware/limiter/limiter.go (about)

     1  package limiter
     2  
     3  import (
     4  	"github.com/gofiber/fiber/v2"
     5  )
     6  
     7  const (
     8  	// X-RateLimit-* headers
     9  	xRateLimitLimit     = "X-RateLimit-Limit"
    10  	xRateLimitRemaining = "X-RateLimit-Remaining"
    11  	xRateLimitReset     = "X-RateLimit-Reset"
    12  )
    13  
    14  type LimiterHandler interface {
    15  	New(config Config) fiber.Handler
    16  }
    17  
    18  // New creates a new middleware handler
    19  func New(config ...Config) fiber.Handler {
    20  	// Set default config
    21  	cfg := configDefault(config...)
    22  
    23  	// Return the specified middleware handler.
    24  	return cfg.LimiterMiddleware.New(cfg)
    25  }