checkPermissions

Checks a Role or a GuildMember against the base permission bits in a Guild, before channel overwrites. Refuses when a permission in scope is missing, or with inverse when one is present.

checkPermissions(
    target: Role | GuildMember,
    ctx: Guild,
    scope: PermissionScope,
    inverse?: boolean,
    errors?: PermissionNoticeOverrides
): void

import { PermissionFlagsBits } from 'discord.js';
import { checkPermissions } from '@seedcord/gateway';

checkPermissions(role, guild, [PermissionFlagsBits.ManageMessages, PermissionFlagsBits.KickMembers]);

// refuse when the member holds Administrator, and replace the refusal
checkPermissions(member, guild, [PermissionFlagsBits.Administrator], true, {
  dangerousNotice: CustomDangerousNotice
});

target

target: Role | GuildMember

ctx

ctx: Guild

scope

scope: PermissionScope

inverse?

inverse?: boolean

errors?

errors?: PermissionNoticeOverrides