limit

^{ref / ratelimiter / limit}

The main middleware function generator.

It accepts either a pre-built Rule object or a Limiter builder instance.

^Source

Type Parameters

C

C extends GrammyContext

Parameters

ruleOrBuilder

ruleOrBuilder: Rule<C> | Limiter<C>

An instance of a Rule or a Limiter builder.

Return Type

(ctx: C, next: NextFunction) => Promise<void>

A grammY-compatible middleware function.