Functioncorev0.1.0-next.5

RequireRole

Requires the caller to hold roleIdroleId, read from the member's role ids. Refuses outside a guild first, then when the role is missing. Roles are guild-global, so there is no scope dimension.

See also:the @Gated decorator from seedcord

RequireRole(
    roleId: string,
    options?: RequireRoleOptions
): Gate<GateContextBase, "RequireRole">

RequireRole(
    roleId: string,
    options?: RequireRoleOptions
): Gate<GateContextBase, "RequireRole">

\@Gated(RequireRole('123456789012345678'))
\@SlashRoute('vip')
class VipHandler extends SlashHandler<'vip'> {
    async execute() {
        // ...
    }
}

\@Gated(RequireRole('123456789012345678'))
\@SlashRoute('vip')
class VipHandler extends SlashHandler<'vip'> {
    async execute() {
        // ...
    }
}

roleId

roleId: string

roleId: string

The role snowflake the caller must hold.

options?

options?: RequireRoleOptions

options?: RequireRoleOptions

Override each refusal, the outside-guild one with notInGuildnotInGuild and the missing-role one with missingRolemissingRole.