dan/discord.js
1
0
Fork 0
mirror of https://github.com/danbulant/discord.js synced 2026-07-08 04:31:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update jsdoc for inline replies

Browse source
This commit is contained in:
monbrey 2020-10-07 14:42:20 +11:00
parent 67c2e56647
commit 975b6cbd94
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
src/structures/interfaces/TextBasedChannel.js
View file

@ -66,7 +66,8 @@ class TextBasedChannel {
* @property {boolean|SplitOptions} [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 * it exceeds the character limit. If an object is provided, these are the options for splitting the message
* @property {UserResolvable} [reply] User to reply to (prefixes the message with a mention, except in DMs) * @property {UserResolvable} [reply] User to reply to (prefixes the message with a mention, except in DMs)
* @property {MessageResolvable} [messageReference] The message to inline-reply to (must be in the same channel) * @property {MessageResolvable|MessageReplyReference} [inlineReplyTo] The message to reply to
* (must be in the same channel)
*/ */
/** /**
@ -77,6 +78,13 @@ class TextBasedChannel {
* @property {Snowflake[]} [roles] Snowflakes of Roles to be parsed as mentions * @property {Snowflake[]} [roles] Snowflakes of Roles to be parsed as mentions
*/ */
/**
* Options provided to control parsing of mentions by Discord
* @typedef {Object} MessageReplyReference
* @property {Snowflake} [messageID] Snowflakes of Users to be parsed as mentions
* @property {Snowflake} [channelID] Snowflakes of Roles to be parsed as mentions
*/
/** /**
* Types of mentions to enable in MessageMentionOptions. * Types of mentions to enable in MessageMentionOptions.
* - `roles` * - `roles`