@distype/cmd
Version:
A command handler for Distype.
133 lines (132 loc) • 3.92 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.Embed = void 0;
/**
* A message embed; specifically, a rich embed.
*
* @example
* ```ts
* new Embed()
* .setTitle(`A title`)
* .setDescription(`Some description`)
* .setColor(0x5865F2);
* ```
* @see [Discord API Reference](https://discord.com/developers/docs/resources/channel#embed-object)
*/
class Embed {
/**
* The raw embed.
*/
_raw;
/**
* Create a message embed.
* @param base An embed to use as a base.
*/
constructor(base = {}) {
this._raw = base;
}
/**
* Set the embed's color.
* @param color The color to use.
*/
setColor(color) {
this._raw.color = color;
return this;
}
/**
* Set the embed's author.
* @param author The author to use. Can be either a string (adapted to `{ name: author }`), or the author object.
*/
setAuthor(author) {
const embedAuthor = typeof author === `string` ? { name: author } : author;
this._raw.author = embedAuthor;
return this;
}
/**
* Set the embed's title.
* @param title The title to use.
* @param url The URL to use (makes the title clickable).
*/
setTitle(title, url) {
this._raw.title = title;
this._raw.url = url;
return this;
}
/**
* Set the embed's thumbnail.
* @param thumbnail The thumbnail to use. Can be either a string (adapted to `{ url: thumbnail }`), or the thumbnail object.
*/
setThumbnail(thumbnail) {
this._raw.thumbnail =
typeof thumbnail === `string` ? { url: thumbnail } : thumbnail;
return this;
}
/**
* Set the embed's description.
* @param description The description to use.
*/
setDescription(description) {
this._raw.description = description;
return this;
}
/**
* Set's the embed's fields.
* Note that this method will overwrite any previously defined fields.
* @param fields The fields to use.
*/
setFields(...fields) {
this._raw.fields = fields;
return this;
}
/**
* Set the embed's image.
* @param image The image to use. Can be either a string (adapted to `{ url: image }`), or the image object.
*/
setImage(image) {
this._raw.image = typeof image === `string` ? { url: image } : image;
return this;
}
/**
* Set the embed's footer.
* @param footer The footer to use. Can be either a string (adapted to `{ name: footer }`), or the footer object.
*/
setFooter(footer) {
const embedFooter = typeof footer === `string` ? { text: footer } : footer;
this._raw.footer = embedFooter;
return this;
}
/**
* Set the embed's timestamp.
* @param time The time to use. Can be a unix millisecond timestamp as a number, and ISO8601 string, or a date.
*/
setTimestamp(time = new Date()) {
this._raw.timestamp =
typeof time === `string`
? time
: (time instanceof Date ? time : new Date(time)).toISOString();
return this;
}
/**
* Get the raw embed.
*/
getRaw() {
return { ...this._raw };
}
/**
* The number of characters in the embed that have properties in [Discord's maximum embed lengths](https://discord.com/developers/docs/resources/channel#embed-limits) list.
*/
getSize() {
return [
this._raw.title,
this._raw.description,
this._raw.footer?.text,
this._raw.author?.name,
...[
this._raw.fields?.reduce((p, c) => `${p}${c.name}${c.value}`, ``) ?? [],
],
]
.map((v) => v?.length ?? 0)
.reduce((p, c) => p + c, 0);
}
}
exports.Embed = Embed;