limit

Documentation

Index

• func PerDay(maxAttempts int) http.Limit
• func PerDays(decayDays, maxAttempts int) http.Limit
• func PerHour(maxAttempts int) http.Limit
• func PerHours(decayHours, maxAttempts int) http.Limit
• func PerMinute(maxAttempts int) http.Limit
• func PerMinutes(decayMinutes, maxAttempts int) http.Limit
• type Limit
  • func NewLimit(maxAttempts, decayMinutes int) *Limit
  • func (r *Limit) By(key string) http.Limit
  • func (r *Limit) Response(callable func(ctx http.Context)) http.Limit

Functions

func PerDay

func PerDay(maxAttempts int) http.Limit

func PerDays

func PerDays(decayDays, maxAttempts int) http.Limit

func PerHour

func PerHour(maxAttempts int) http.Limit

func PerHours

func PerHours(decayHours, maxAttempts int) http.Limit

func PerMinute

func PerMinute(maxAttempts int) http.Limit

func PerMinutes

func PerMinutes(decayMinutes, maxAttempts int) http.Limit

Types

type Limit

type Limit struct {
	// The rate limit signature key.
	Key string
	// The maximum number of attempts allowed within the given number of minutes.
	MaxAttempts int
	// The number of minutes until the rate limit is reset.
	DecayMinutes int
	// The response generator callback.
	ResponseCallback func(ctx http.Context)
}

func NewLimit

func NewLimit(maxAttempts, decayMinutes int) *Limit

func (*Limit) By

func (r *Limit) By(key string) http.Limit

func (*Limit) Response

func (r *Limit) Response(callable func(ctx http.Context)) http.Limit