checkBotPermissions

Checks if the bot has required permissions in a Guild or TextChannel. Refuses when a required permission is missing.

checkBotPermissions(
    target: Guild | TextChannel,
    scope: PermissionScope,
    inverse?: boolean,
    errors?: PermissionErrorNoticeOverrides
): void

checkBotPermissions(
    target: Guild | TextChannel,
    scope: PermissionScope,
    inverse?: boolean,
    errors?: PermissionErrorNoticeOverrides
): void

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

// Check if the bot has SendMessages and ViewChannel permissions in a text channel
checkBotPermissions(textChannel, [
  PermissionFlagsBits.SendMessages,
  PermissionFlagsBits.ViewChannel
]);

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

// Check if the bot has SendMessages and ViewChannel permissions in a text channel
checkBotPermissions(textChannel, [
  PermissionFlagsBits.SendMessages,
  PermissionFlagsBits.ViewChannel
]);

target

target: Guild | TextChannel

target: Guild | TextChannel

Guild or text channel to check in

scope

scope: PermissionScope

scope: PermissionScope

Permission bits to validate

inverse?

inverse?: boolean

inverse?: boolean

Whether to check for absence of the given permissions

errors?

errors?: PermissionErrorNoticeOverrides

errors?: PermissionErrorNoticeOverrides

Optional custom error constructors