Gated

Attaches gates to a handler. The gates run before executeexecute, and a gate refusing stops the handler with the reply or drop the gate threw. Multiple gates are ANDed, so each must pass. A gate that requires a context the handler does not provide (a button gate on a slash handler, an interaction gate on an event handler) is a compile error at this line, and the error names the gate and the handler kind. Place it above the route decorator.

Combine gates with andand or oror to build a single gate from multiple arms.

See also:defineGate, defineEffectGate

Gated<Gates>(
    gates: Gates
): <TCtor extends AnyHandlerCtor>(
    ctor: FitAll<TCtor, Gates> extends Gates
        ? TCtor
        : FitAll<TCtor, Gates>
) => void

Gated<Gates>(
    gates: Gates
): <TCtor extends AnyHandlerCtor>(
    ctor: FitAll<TCtor, Gates> extends Gates
        ? TCtor
        : FitAll<TCtor, Gates>
) => void

import { PermissionFlagsBits } from 'discord.js';

\@Gated(GuildOnly(), RequirePermissions([PermissionFlagsBits.Administrator]))
\@SlashRoute('maintenance')
class Maintenance extends SlashHandler<'maintenance'> {
    async execute() {
        // both gates passed, so this runs in a guild with an admin caller
    }
}

import { PermissionFlagsBits } from 'discord.js';

\@Gated(GuildOnly(), RequirePermissions([PermissionFlagsBits.Administrator]))
\@SlashRoute('maintenance')
class Maintenance extends SlashHandler<'maintenance'> {
    async execute() {
        // both gates passed, so this runs in a guild with an admin caller
    }
}

Gates

The non-empty tuple of gates to run, in order, against the handler's context.

Gates

Gates

The non-empty tuple of gates to run, in order, against the handler's context.

gates

gates: Gates

gates: Gates

One or more gates to attach, each ANDed so the handler runs only when all pass.