Skip to main content
Module

x/discordeno/helpers/roles/createRole.ts

Discord API library for Deno
Extremely Popular
Go to Latest
File
import type { Bot } from "../../bot.ts";import { DiscordRole } from "../../types/discord.ts";import { PermissionStrings } from "../../types/shared.ts";
/** Create a new role for the guild. Requires the MANAGE_ROLES permission. */export async function createRole(bot: Bot, guildId: bigint, options: CreateGuildRole, reason?: string) { const result = await bot.rest.runMethod<DiscordRole>(bot.rest, "POST", bot.constants.routes.GUILD_ROLES(guildId), { name: options.name, color: options.color, hoist: options.hoist, mentionable: options.mentionable, permissions: bot.utils.calculateBits(options?.permissions || []), icon: options.icon, unicode_emoji: options.unicodeEmoji, reason, });
return bot.transformers.role(bot, { role: result, guildId, });}
export interface CreateGuildRole { /** Name of the role, default: "new role" */ name?: string; /** Bitwise value of the enabled/disabled permissions, default: everyone permissions in guild */ permissions?: PermissionStrings[]; /** RGB color value, default: 0 */ color?: number; /** Whether the role should be displayed separately in the sidebar, default: false */ hoist?: boolean; /** Whether the role should be mentionable, default: false */ mentionable?: boolean; /** The role's unicode emoji (if the guild has the `ROLE_ICONS` feature) */ unicodeEmoji?: string; /** the role's icon image (if the guild has the `ROLE_ICONS` feature) */ icon?: string;}