Functionseedcordv0.13.0

defineGate

Builds a GateGate from a check. The check refuses by throwing a Notice or a Silence and passes by returning. The required context is inferred from ctxctx, so annotate it as narrowly as the fields the check reads. No annotation defaults to GateContextBaseGateContextBase, an agnostic gate that fits every handler.

See also:defineEffectGate, Gated

defineGate<Name, Ctx>(
    name: Name,
    fn: (ctx: Ctx) => void | Promise<void>
): Gate<Ctx, Name>

defineGate<Name, Ctx>(
    name: Name,
    fn: (ctx: Ctx) => void | Promise<void>
): Gate<Ctx, Name>

// a gate factory that takes its own option and closes over it
function MinRoleCount(min: number): Gate<InteractionGateContext, 'MinRoleCount'> {
    return defineGate('MinRoleCount', (ctx: InteractionGateContext) => {
        if (ctx.member && ctx.member.roles.cache.size < min) throw new NotEnoughRoles(min);
    });
}

// a gate factory that takes its own option and closes over it
function MinRoleCount(min: number): Gate<InteractionGateContext, 'MinRoleCount'> {
    return defineGate('MinRoleCount', (ctx: InteractionGateContext) => {
        if (ctx.member && ctx.member.roles.cache.size < min) throw new NotEnoughRoles(min);
    });
}

// agnostic gate (no ctx annotation): fits any handler
const Owner = defineGate('owner', (ctx) => {
    if (!ctx.user) throw new NotOwner();
});

// agnostic gate (no ctx annotation): fits any handler
const Owner = defineGate('owner', (ctx) => {
    if (!ctx.user) throw new NotOwner();
});

// interaction-only gate: annotate ctx to narrow the required context
const SlashGate = defineGate('slash', (ctx: InteractionGateContext) => {
    void ctx.interaction;
});

// interaction-only gate: annotate ctx to narrow the required context
const SlashGate = defineGate('slash', (ctx: InteractionGateContext) => {
    void ctx.interaction;
});

import { Events } from 'discord.js';

// event-only gate keyed to one event
const OnMessage = defineGate('msg', (ctx: EventGateContext<Events.MessageCreate>) => {
    void ctx.payload;
});

import { Events } from 'discord.js';

// event-only gate keyed to one event
const OnMessage = defineGate('msg', (ctx: EventGateContext<Events.MessageCreate>) => {
    void ctx.payload;
});

Name

The gate's name captured as a literal, so a mismatch error can name the gate.

Name

Name

The gate's name captured as a literal, so a mismatch error can name the gate.

Ctx

The context the check reads, inferred from the ctxctx annotation.

Ctx

Ctx

The context the check reads, inferred from the ctxctx annotation.

name

name: Name

name: Name

The gate's name, used in mismatch errors.

fn

fn: (ctx: Ctx) => void | Promise<void>

fn: (ctx: Ctx) => void | Promise<void>

The check, which refuses by throwing a Notice or a Silence and passes by returning.

Functionseedcordv0.13.0

defineGate

See also:defineEffectGate, Gated

defineGate<Name, Ctx>(
    name: Name,
    fn: (ctx: Ctx) => void | Promise<void>
): Gate<Ctx, Name>

defineGate<Name, Ctx>(
    name: Name,
    fn: (ctx: Ctx) => void | Promise<void>
): Gate<Ctx, Name>

// a gate factory that takes its own option and closes over it
function MinRoleCount(min: number): Gate<InteractionGateContext, 'MinRoleCount'> {
    return defineGate('MinRoleCount', (ctx: InteractionGateContext) => {
        if (ctx.member && ctx.member.roles.cache.size < min) throw new NotEnoughRoles(min);
    });
}

// a gate factory that takes its own option and closes over it
function MinRoleCount(min: number): Gate<InteractionGateContext, 'MinRoleCount'> {
    return defineGate('MinRoleCount', (ctx: InteractionGateContext) => {
        if (ctx.member && ctx.member.roles.cache.size < min) throw new NotEnoughRoles(min);
    });
}

// agnostic gate (no ctx annotation): fits any handler
const Owner = defineGate('owner', (ctx) => {
    if (!ctx.user) throw new NotOwner();
});

// agnostic gate (no ctx annotation): fits any handler
const Owner = defineGate('owner', (ctx) => {
    if (!ctx.user) throw new NotOwner();
});

// interaction-only gate: annotate ctx to narrow the required context
const SlashGate = defineGate('slash', (ctx: InteractionGateContext) => {
    void ctx.interaction;
});

// interaction-only gate: annotate ctx to narrow the required context
const SlashGate = defineGate('slash', (ctx: InteractionGateContext) => {
    void ctx.interaction;
});

import { Events } from 'discord.js';

// event-only gate keyed to one event
const OnMessage = defineGate('msg', (ctx: EventGateContext<Events.MessageCreate>) => {
    void ctx.payload;
});

import { Events } from 'discord.js';

// event-only gate keyed to one event
const OnMessage = defineGate('msg', (ctx: EventGateContext<Events.MessageCreate>) => {
    void ctx.payload;
});

Name

The gate's name captured as a literal, so a mismatch error can name the gate.

Name

Name

The gate's name captured as a literal, so a mismatch error can name the gate.

Ctx

The context the check reads, inferred from the ctxctx annotation.

Ctx

Ctx

The context the check reads, inferred from the ctxctx annotation.

name

name: Name

name: Name

The gate's name, used in mismatch errors.

fn

fn: (ctx: Ctx) => void | Promise<void>

fn: (ctx: Ctx) => void | Promise<void>

The check, which refuses by throwing a Notice or a Silence and passes by returning.