Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-09 16:13:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

feat(MessageEmbed): add spliceField method (#2857)

Browse Source 
* Add spliceField and refactor to prevent code dupe

* String() was for a falsy check, fixed

* requested: remove embed field count checks
This commit is contained in:
bdistin
2018-10-10 02:57:56 -05:00
committed by SpaceEEC
parent 1fe36087d4
commit 8feb874586
2 changed files with 42 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
src/structures/MessageEmbed.js
View File

@@ -51,12 +51,16 @@ class MessageEmbed {
this.timestamp = data.timestamp ? new Date(data.timestamp).getTime() : null;
/**
* The fields of this embed
* @type {Object[]}
* @typedef {Object} EmbedField
* @property {string} name The name of this field
* @property {string} value The value of this field
* @property {boolean} inline If this field will be displayed inline
*/
/**
* The fields of this embed
* @type {EmbedField[]}
*/
this.fields = data.fields ? data.fields.map(Util.cloneObject) : [];
/**
@@ -170,13 +174,8 @@ class MessageEmbed {
* @param {boolean} [inline=false] Set the field to display inline
* @returns {MessageEmbed}
*/
addField(name, value, inline = false) {
if (this.fields.length >= 25) throw new RangeError('EMBED_FIELD_COUNT');
name = Util.resolveString(name);
if (!String(name)) throw new RangeError('EMBED_FIELD_NAME');
value = Util.resolveString(value);
if (!String(value)) throw new RangeError('EMBED_FIELD_VALUE');
this.fields.push({ name, value, inline });
addField(name, value, inline) {
this.fields.push(this.constructor.checkField(name, value, inline));
return this;
}
@@ -185,10 +184,28 @@ class MessageEmbed {
* @param {boolean} [inline=false] Set the field to display inline
* @returns {MessageEmbed}
*/
addBlankField(inline = false) {
addBlankField(inline) {
return this.addField('\u200B', '\u200B', inline);
}
/**
* Removes, replaces, and inserts fields in the embed (max 25).
* @param {number} index The index to start at
* @param {number} deleteCount The number of fields to remove
* @param {StringResolvable} [name] The name of the field
* @param {StringResolvable} [value] The value of the field
* @param {boolean} [inline=false] Set the field to display inline
* @returns {MessageEmbed}
*/
spliceField(index, deleteCount, name, value, inline) {
if (name && value) {
this.fields.splice(index, deleteCount, this.constructor.checkField(name, value, inline));
} else {
this.fields.splice(index, deleteCount);
}
return this;
}
/**
* Sets the file to upload alongside the embed. This file can be accessed via `attachment://fileName.extension` when
* setting an embed image or author/footer icons. Multiple files can be attached.
@@ -328,6 +345,21 @@ class MessageEmbed {
} : null,
};
}
/**
* Checks for valid field input and resolves strings
* @param {StringResolvable} name The name of the field
* @param {StringResolvable} value The value of the field
* @param {boolean} [inline=false] Set the field to display inline
* @returns {EmbedField}
*/
static checkField(name, value, inline = false) {
name = Util.resolveString(name);
if (!name) throw new RangeError('EMBED_FIELD_NAME');
value = Util.resolveString(value);
if (!value) throw new RangeError('EMBED_FIELD_VALUE');
return { name, value, inline };
}
}
module.exports = MessageEmbed;