Functionseedcordv0.10.6

checkPermissions

Checks permissions for a RoleRole or a GuildMemberGuildMember in a GuildGuild.

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

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

Overloads

Overload 1Overload 2Overload 3

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

// Check if a role has ManageMessages and KickMembers permissions in a guild
checkPermissions(role, guild, [
  PermissionFlagsBits.ManageMessages,
  PermissionFlagsBits.KickMembers
]);

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

// Check if a role has ManageMessages and KickMembers permissions in a guild
checkPermissions(role, guild, [
  PermissionFlagsBits.ManageMessages,
  PermissionFlagsBits.KickMembers
]);

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

// Ensure a member does NOT have Administrator permission in a guild and show custom errors
checkPermissions(member, guild, [
  PermissionFlagsBits.Administrator
], true, {
  missing: CustomMissingPermissionsError,
  dangerous: CustomDangerousPermissionsError
});

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

// Ensure a member does NOT have Administrator permission in a guild and show custom errors
checkPermissions(member, guild, [
  PermissionFlagsBits.Administrator
], true, {
  missing: CustomMissingPermissionsError,
  dangerous: CustomDangerousPermissionsError
});

target

target: Role | GuildMember

target: Role | GuildMember

Role or member to check

ctx

ctx: Guild

ctx: Guild

Guild context

scope

scope: BotPermissionScope

scope: BotPermissionScope

Permission bits to validate

inverse?

inverse?: boolean

inverse?: boolean

Whether to ensure absence of the given permissions

errors?

errors?: PermissionErrorCtors

errors?: PermissionErrorCtors

Optional custom error constructors

import { PermissionFlagsBits } from 'discord.js'; import { checkPermissions } from 'seedcord'; // Check if a role has ManageMessages and KickMembers permissions in a guild checkPermissions(role, guild, [ PermissionFlagsBits.ManageMessages, PermissionFlagsBits.KickMembers ]);

import { PermissionFlagsBits } from 'discord.js'; import { checkPermissions } from 'seedcord'; // Ensure a member does NOT have Administrator permission in a guild and show custom errors checkPermissions(member, guild, [ PermissionFlagsBits.Administrator ], true, { missing: CustomMissingPermissionsError, dangerous: CustomDangerousPermissionsError });