Functionseedcordv0.15.0

Cooldown

Allows limitlimit uses per window, scoped by perper. A number durationduration is seconds, a string is a duration like 30m30m or 24h24h. An unparseable string throws a SeedcordTypeError at construction. The slot is charged in commit, only after the whole gate set passes, so a later refusal never burns the cooldown. Each call gets its own bucket, so two handlers never share a window. Reword the refusal with messagemessage or replace it with noticenotice.

See also:Gated, RateLimiter

Cooldown(
    duration: number | ValidDuration,
    options?: CooldownOptions
): EffectGate<GateContextBase, "Cooldown">

Cooldown(
    duration: number | ValidDuration,
    options?: CooldownOptions
): EffectGate<GateContextBase, "Cooldown">

// a number argument is SECONDS
\@Gated(Cooldown(5))
\@SlashRoute('daily')
class DailyHandler extends SlashHandler<'daily'> {
    async execute() {
        // ...
    }
}

// a number argument is SECONDS
\@Gated(Cooldown(5))
\@SlashRoute('daily')
class DailyHandler extends SlashHandler<'daily'> {
    async execute() {
        // ...
    }
}

// a string is a duration, here scoped per guild instead of per user
Cooldown('30m', { per: 'guild' });

// a string is a duration, here scoped per guild instead of per user
Cooldown('30m', { per: 'guild' });

// a burst, 3 uses per 10 minutes per user, then it refuses until a slot frees
\@Gated(Cooldown('10m', { limit: 3 }))
\@SlashRoute('report')
class ReportHandler extends SlashHandler<'report'> {
    async execute() {
        // ...
    }
}

// a burst, 3 uses per 10 minutes per user, then it refuses until a slot frees
\@Gated(Cooldown('10m', { limit: 3 }))
\@SlashRoute('report')
class ReportHandler extends SlashHandler<'report'> {
    async execute() {
        // ...
    }
}

duration

duration: number | ValidDuration

duration: number | ValidDuration

A number is seconds, a string is a duration like 30m30m or 24h24h. An unparseable string throws a SeedcordTypeError.

options?

options?: CooldownOptions

options?: CooldownOptions

Sets the scope with perper, the uses per window with limitlimit, and the refusal text with messagemessage or noticenotice.