hasPermsToAssign

Validates that the bot can assign a target role. Refuses when the target role is above the bot's, is managed, or the bot lacks Manage Roles.

Throws:

A Notice on refusal, or a SeedcordError when the bot has no role in the guild's role cache.

hasPermsToAssign(
    roleOrOptions: Role | HasPermsToAssignOptions
): void

import { hasPermsToAssign } from '@seedcord/gateway';

// Check if the bot can assign a specific role
hasPermsToAssign(role);

// Check with custom error handling
hasPermsToAssign({
  targetRole: role,
  noticeOverrides: {
    higherNotice: CustomHigherNotice,
    managedNotice: CustomManagedNotice,
    missingNotice: CustomMissingPermissionsNotice
  }
});

roleOrOptions

roleOrOptions: Role | HasPermsToAssignOptions

Target role or complete options for the check

Loading…

Functiongatewayv0.2.1

hasPermsToAssign

Validates that the bot can assign a target role. Refuses when the target role is above the bot's, is managed, or the bot lacks Manage Roles.

Throws:

A Notice on refusal, or a SeedcordError when the bot has no role in the guild's role cache.

hasPermsToAssign(
    roleOrOptions: Role | HasPermsToAssignOptions
): void

import { hasPermsToAssign } from '@seedcord/gateway';

// Check if the bot can assign a specific role
hasPermsToAssign(role);

// Check with custom error handling
hasPermsToAssign({
  targetRole: role,
  noticeOverrides: {
    higherNotice: CustomHigherNotice,
    managedNotice: CustomManagedNotice,
    missingNotice: CustomMissingPermissionsNotice
  }
});

roleOrOptions

roleOrOptions: Role | HasPermsToAssignOptions

Target role or complete options for the check