httprate

Jun 29, 2026

Changes in this version

+ func CanonicalizeIP(ip string) string

+ func LimitBy(requestLimit int, windowLength time.Duration, keyFn KeyFunc, options ...Option) func(next http.Handler) http.Handler

type KeyFunc

+ func JoinKeys(fns ...KeyFunc) KeyFunc

Aug 28, 2024

Changes in this version

+ func Key(key string) func(r *http.Request) (string, error)

Aug 23, 2024

Changes in this version

type RateLimiter

+ func (l *RateLimiter) RespondOnLimit(w http.ResponseWriter, r *http.Request, key string) bool

Aug 23, 2024

Changes in this version

+ type RateLimiter struct

+ func (l *RateLimiter) Counter() LimitCounter

+ func (l *RateLimiter) Handler(next http.Handler) http.Handler

+ func (l *RateLimiter) OnLimit(w http.ResponseWriter, r *http.Request, key string) bool

+ func (l *RateLimiter) Status(key string) (bool, float64, error)

Aug 8, 2024

Changes in this version

type Option

+ func WithErrorHandler(h func(http.ResponseWriter, *http.Request, error)) Option

Jul 25, 2024

Changes in this version

+ func NewLocalLimitCounter(windowLength time.Duration) *localCounter

Jul 25, 2024

Changes in this version

type Option

+ func WithResponseHeaders(headers ResponseHeaders) Option

+ type ResponseHeaders struct

+ Increment string

+ Limit string

+ Remaining string

+ Reset string

+ RetryAfter string

Feb 27, 2024

Changes in this version

+ func WithRequestLimit(ctx context.Context, value int) context.Context

Dec 6, 2023

Changes in this version

+ func WithIncrement(ctx context.Context, value int) context.Context

type LimitCounter

+ IncrementBy func(key string, currentWindow time.Time, amount int) error

Apr 15, 2023

Changes in this version

type Option

+ func WithNoop() Option

Aug 26, 2022

Changes in this version

type LimitCounter

+ Config func(requestLimit int, windowLength time.Duration)

type Option

+ func WithKeyByIP() Option

+ func WithKeyByRealIP() Option

Jul 26, 2022

Changes in this version

+ func KeyByRealIP(r *http.Request) (string, error)

+ func LimitByRealIP(requestLimit int, windowLength time.Duration) func(next http.Handler) http.Handler

Jul 12, 2021

Changes in this version

+ func KeyByEndpoint(r *http.Request) (string, error)

+ func KeyByIP(r *http.Request) (string, error)

+ func Limit(requestLimit int, windowLength time.Duration, options ...Option) func(next http.Handler) http.Handler

+ func LimitAll(requestLimit int, windowLength time.Duration) func(next http.Handler) http.Handler

+ func LimitByIP(requestLimit int, windowLength time.Duration) func(next http.Handler) http.Handler

+ func LimitCounterKey(key string, window time.Time) uint64

+ func NewRateLimiter(requestLimit int, windowLength time.Duration, options ...Option) *rateLimiter

+ type KeyFunc func(r *http.Request) (string, error)

+ type LimitCounter interface

+ Get func(key string, previousWindow, currentWindow time.Time) (int, int, error)

+ Increment func(key string, currentWindow time.Time) error

+ type Option func(rl *rateLimiter)

+ func WithKeyFuncs(keyFuncs ...KeyFunc) Option

+ func WithLimitCounter(c LimitCounter) Option

+ func WithLimitHandler(h http.HandlerFunc) Option