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

Clean up MessageOptions JSDoc

Browse Source
This commit is contained in:
Schuyler Cebulskie
2016-09-12 16:23:15 -04:00
parent 92775abb49
commit 5464ee7e64
2 changed files with 3 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/structures/interface/TextBasedChannel.js
View File

@@ -23,21 +23,13 @@ class TextBasedChannel {
}
/**
* Options that can be passed into sendMessage or sendTTSMessage:
* ```js
* {
* tts: false,
* nonce: '',
* disable_everyone: false,
* split: false,
* };
* ```
* Options that can be passed into sendMessage, sendTTSMessage, sendFile, sendCode, or Message.reply
* @typedef {Object} MessageOptions
* @property {boolean} [tts=false] Whether or not the message should be spoken aloud
* @property {string} [nonce=''] The nonce for the message
* @property {boolean} [disable_everyone=this.client.options.disable_everyone] Whether or not @everyone and @here
* should be replaced with plain-text
* @property {boolean|SplitObject} [split=false] Whether or not the message should be split into multiple messages if
* @property {boolean|SplitOptions} [split=false] Whether or not the message should be split into multiple messages if
* it exceeds the character limit. If an object is provided, these are the options for splitting the message.
*/