earlydata

Documentation

Index

• Constants
• Variables
• func IsEarly(c fiber.Ctx) bool
• func New(config ...Config) fiber.Handler
• type Config

Constants

const (
	DefaultHeaderName      = "Early-Data"
	DefaultHeaderTrueValue = "1"
)

Variables

var ConfigDefault = Config{
	IsEarlyData: func(c fiber.Ctx) bool {
		return c.Get(DefaultHeaderName) == DefaultHeaderTrueValue
	},

	AllowEarlyData: func(c fiber.Ctx) bool {
		return fiber.IsMethodSafe(c.Method())
	},

	Error: fiber.ErrTooEarly,
}

ConfigDefault is the default config

Functions

func IsEarly

func IsEarly(c fiber.Ctx) bool

IsEarlyData returns true if the request is an early-data request

func New

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

New creates a new middleware handler https://datatracker.ietf.org/doc/html/rfc8470#section-5.1

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

	// IsEarlyData returns whether the request is an early-data request.
	//
	// Optional. Default: a function which checks if the "Early-Data" request header equals "1".
	IsEarlyData func(c fiber.Ctx) bool

	// AllowEarlyData returns whether the early-data request should be allowed or rejected.
	//
	// Optional. Default: a function which rejects the request on unsafe and allows the request on safe HTTP request methods.
	AllowEarlyData func(c fiber.Ctx) bool

	// Error is returned in case an early-data request is rejected.
	//
	// Optional. Default: fiber.ErrTooEarly.
	Error error
}

Config defines the config for middleware.