Limiter

^{ref / ratelimiter / Limiter}

A fluent API builder for constructing rate-limiter rules.

^Source

Type Parameters

C

C extends GrammyContext

Constructors

Limiter();

^Source

Methods

fixedWindow

fixedWindow();

Sets the limiting strategy to Fixed Window.

^Source

tokenBucket

tokenBucket();

Sets the limiting strategy to Token Bucket.

^Source

customStrategy

customStrategy();

Sets a custom limiting strategy.

^Source

useStorage

useStorage();

Sets the storage engine for the rule.

^Source

limitFor

limitFor();

Defines what entity to rate-limit.

^Source

on

on();

Registers an event listener for this limiter instance. This allows for observing the limiter’s behavior for logging or analytics.

^Source

off

off();

Unregisters an event listener.

^Source

withKeyPrefix

withKeyPrefix();

Sets a prefix for all keys generated for this rule. Useful for preventing key collisions between different rules in the same storage.

^Source

onlyIf

onlyIf();

Rate limiter will only run if this function returns true.

^Source

onThrottled

onThrottled();

Defines the callback to execute when a request is throttled (rate-limited).

^Source

withPenalty

withPenalty();

Enables and configures the “Penalty Box” feature.

^Source

build

build();

Finalizes the configuration and returns a validated Rule instance.

^Source