Document editing message flags (#567)

abalabahaha · Nov 23, 2019 · 1567f9d · 1567f9d
1 parent 3bdeb5b
commit 1567f9d
Show file tree

Hide file tree

Showing 5 changed files with 7 additions and 3 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -495,7 +495,7 @@ declare namespace Eris {
     [key: string]: {};
   }
 
-  type MessageContent = string | { content?: string; tts?: boolean; disableEveryone?: boolean; embed?: EmbedOptions };
+  type MessageContent = string | { content?: string; tts?: boolean; disableEveryone?: boolean; embed?: EmbedOptions; flags?: number };
   interface MessageFile {
     file: Buffer | string;
     name: string;

diff --git a/lib/Client.js b/lib/Client.js
@@ -1049,6 +1049,7 @@ class Client extends EventEmitter {
     * @arg {String} content.content A content string
     * @arg {Boolean} [content.disableEveryone] Whether to filter @everyone/@here or not (overrides default)
     * @arg {Object} [content.embed] An embed object. See [the official Discord API documentation entry](https://discordapp.com/developers/docs/resources/channel#embed-object) for object structure
+    * @arg {Number} [content.flags] A number representing the flags to apply to the message. See [the official Discord API documentation entry](https://discordapp.com/developers/docs/resources/channel#message-object-message-flags) for flags reference
     * @returns {Promise<Message>}
     */
     editMessage(channelID, messageID, content) {
@@ -1059,8 +1060,8 @@ class Client extends EventEmitter {
                 };
             } else if(content.content !== undefined && typeof content.content !== "string") {
                 content.content = "" + content.content;
-            } else if(content.content === undefined && !content.embed) {
-                return Promise.reject(new Error("No content or embed"));
+            } else if(content.content === undefined && !content.embed && content.flags === undefined) {
+                return Promise.reject(new Error("No content, embed or flags"));
             }
             if(content.content && (content.disableEveryone !== undefined ? content.disableEveryone : this.options.disableEveryone)) {
                 content.content = content.content.replace(/@everyone/g, "@\u200beveryone").replace(/@here/g, "@\u200bhere");

diff --git a/lib/structures/Message.js b/lib/structures/Message.js
@@ -226,6 +226,7 @@ class Message extends Base {
     * @arg {String} content.content A content string
     * @arg {Boolean} [content.disableEveryone] Whether to filter @everyone/@here or not (overrides default)
     * @arg {Object} [content.embed] An embed object. See [the official Discord API documentation entry](https://discordapp.com/developers/docs/resources/channel#embed-object) for object structure
+    * @arg {Number} [content.flags] A number representing the flags to apply to the message. See [the official Discord API documentation entry](https://discordapp.com/developers/docs/resources/channel#message-object-message-flags) for flags reference
     * @returns {Promise<Message>}
     */
     edit(content) {

diff --git a/lib/structures/PrivateChannel.js b/lib/structures/PrivateChannel.js
@@ -118,6 +118,7 @@ class PrivateChannel extends Channel {
     * @arg {String} content.content A content string
     * @arg {Boolean} [content.disableEveryone] Whether to filter @everyone/@here or not (overrides default)
     * @arg {Object} [content.embed] An embed object. See [the official Discord API documentation entry](https://discordapp.com/developers/docs/resources/channel#embed-object) for object structure
+    * @arg {Number} [content.flags] A number representing the flags to apply to the message. See [the official Discord API documentation entry](https://discordapp.com/developers/docs/resources/channel#message-object-message-flags) for flags reference
     * @returns {Promise<Message>}
     */
     editMessage(messageID, content) {

diff --git a/lib/structures/TextChannel.js b/lib/structures/TextChannel.js
@@ -162,6 +162,7 @@ class TextChannel extends GuildChannel {
     * @arg {String} content.content A content string
     * @arg {Boolean} [content.disableEveryone] Whether to filter @everyone/@here or not (overrides default)
     * @arg {Object} [content.embed] An embed object. See [the official Discord API documentation entry](https://discordapp.com/developers/docs/resources/channel#embed-object) for object structure
+    * @arg {Number} [content.flags] A number representing the flags to apply to the message. See [the official Discord API documentation entry](https://discordapp.com/developers/docs/resources/channel#message-object-message-flags) for flags reference
     * @returns {Promise<Message>}
     */
     editMessage(messageID, content) {