Skip to main content
Module

x/discordeno/helpers/emojis/createEmoji.ts

Discord API library for Deno
Latest
File
import type { Bot } from "../../bot.ts";import { BigString, WithReason } from "../../mod.ts";import { Emoji } from "../../transformers/emoji.ts";import { DiscordEmoji } from "../../types/discord.ts";
/** * Creates an emoji in a guild. * * @param bot - The bot instance to use to make the request. * @param guildId - The ID of the guild in which to create the emoji. * @param options - The parameters for the creation of the emoji. * @returns An instance of the created {@link Emoji}. * * @remarks * Requires the `MANAGE_EMOJIS_AND_STICKERS` permission. * * Emojis have a maximum file size of 256 kilobits. Attempting to upload a larger emoji will cause the route to return 400 Bad Request. * * Fires a _Guild Emojis Update_ gateway event. * * @see {@link https://discord.com/developers/docs/resources/emoji#create-guild-emoji} */export async function createEmoji(bot: Bot, guildId: BigString, options: CreateGuildEmoji): Promise<Emoji> { if (options.image && !options.image.startsWith("data:image/")) { options.image = await bot.utils.urlToBase64(options.image); }
const result = await bot.rest.runMethod<DiscordEmoji>( bot.rest, "POST", bot.constants.routes.GUILD_EMOJIS(guildId), { name: options.name, image: options.image, roles: options.roles?.map((role) => role.toString()), reason: options.reason, }, );
return bot.transformers.emoji(bot, result);}
/** https://discord.com/developers/docs/resources/emoji#create-guild-emoji */export interface CreateGuildEmoji extends WithReason { /** Name of the emoji */ name: string; /** The 128x128 emoji image. Emojis and animated emojis have a maximum file size of 256kb. Attempting to upload an emoji larger than this limit will fail and return 400 Bad Request and an error message, but not a JSON status code. If a URL is provided to the image parameter, Discordeno will automatically convert it to a base64 string internally. */ image: string; /** Roles allowed to use this emoji */ roles?: BigString[];}