discordjs-appemojis
v1.0.2
Published
This package allows you to easily create, delete, modify, and get emojis for your discord bot!
Readme
EmojiHandler Class
The EmojiHandler class provides methods for managing emojis within a Discord application. It supports creating, deleting, editing, retrieving, and listing emojis. Additionally, it includes utility functions for handling emoji data.
Installation
To use the EmojiHandler class, ensure you have the required dependencies:
npm install discord.js node-fetchUsage
Importing the Class
const EmojiHandler = require('discordjs-appemojis');Creating an Instance
const { Client } = require('discord.js');
const client = new Client({ intents: [] });
const emojiHandler = new EmojiHandler(client);Methods
createEmoji(emojiName, imageUrl)
Creates a new emoji with the specified name and image.
Parameters:
emojiName(string): The name of the emoji.imageUrl(string): URL of the image to use for the emoji.
Returns:
- A promise that resolves to the response from the Discord API.
Example:
await emojiHandler.createEmoji('myEmoji', 'https://example.com/image.png');deleteEmoji(emojiId)
Deletes an existing emoji by its ID.
Parameters:
emojiId(string): The ID of the emoji to delete.
Returns:
- A promise that resolves to
{ success: true }upon successful deletion.
Example:
await emojiHandler.deleteEmoji('123456789012345678');getEmoji(emojiId)
Retrieves information about an emoji by its ID.
Parameters:
emojiId(string): The ID of the emoji to retrieve.
Returns:
- A promise that resolves to the emoji object.
Example:
const emoji = await emojiHandler.getEmoji('123456789012345678');
console.log(emoji);editEmoji(emojiId, emojiName)
Modifies the name of an existing emoji.
Parameters:
emojiId(string): The ID of the emoji to edit.emojiName(string): The new name for the emoji.
Returns:
- A promise that resolves to the updated emoji object.
Example:
await emojiHandler.editEmoji('123456789012345678', 'newName');getAllEmojis()
Retrieves a list of all emojis for the application.
Returns:
- A promise that resolves to an array of emoji objects.
Example:
const emojis = await emojiHandler.getAllEmojis();
console.log(emojis);fetchImageBuffer(url)
Fetches an image from a URL and returns it as a buffer.
Parameters:
url(string): The URL of the image.
Returns:
- A promise that resolves to the image buffer.
Example:
const buffer = await emojiHandler.fetchImageBuffer('https://example.com/image.png');getEmojiNameById(emojiId)
Gets the name of an emoji by its ID.
Parameters:
emojiId(string): The ID of the emoji.
Returns:
- A promise that resolves to the name of the emoji.
Example:
const name = await emojiHandler.getEmojiNameById('123456789012345678');
console.log(name);isEmojiExist(emojiId)
Checks if an emoji exists by its ID.
Parameters:
emojiId(string): The ID of the emoji.
Returns:
- A promise that resolves to
trueif the emoji exists, otherwisefalse.
Example:
const exists = await emojiHandler.isEmojiExist('123456789012345678');
console.log(exists);getRandomName(type)
Generates a random name based on the specified type.
Parameters:
type(string): The type of name to generate. Available types are'string','number', and'san'.
Returns:
- A random name as a string.
Example:
const randomName = emojiHandler.getRandomName('string');
console.log(randomName);License
MIT License. See LICENSE for more information.
