Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(AllowedMentions): add support for MessageOptions#allowedMentions #3893

Merged
merged 12 commits into from
Mar 19, 2020
Merged

feat(AllowedMentions): add support for MessageOptions#allowedMentions #3893

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e528389
feat(Allowed Mentions): Add support for new Allowed Mentions message …
monbrey Mar 4, 2020
70f82ff
fix(docs): Update JSDoc for feature
monbrey Mar 4, 2020
f3235c1
fix(apimessage): translate the propery into snake_case
monbrey Mar 4, 2020
34318c5
fix(typings): message mention options should be optional
monbrey Mar 4, 2020
cbbc833
fix(docs): jsdoc typings for MessageMentionOptions
monbrey Mar 4, 2020
dd42469
fix(mentions): use Resolvables for MessageMentionOptions
monbrey Mar 4, 2020
98d6b2e
fix(docs): typedef for MessageMentionTypes
monbrey Mar 8, 2020
56cfffb
Update typings/index.d.ts
monbrey Mar 8, 2020
8a5d482
fix(mentions): drop support for Resolvables
monbrey Mar 9, 2020
dae522d
Merge branch 'master' into allowed-mentions
monbrey Mar 17, 2020
b4bd8c2
fix(AllowedMentions): remove the whole resolve function
monbrey Mar 17, 2020
6b65949
fix(docs): revert change to Resolvables
monbrey Mar 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/structures/APIMessage.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,6 +184,7 @@ class APIMessage {
embeds,
username,
avatar_url: avatarURL,
allowed_mentions: this.options.allowedMentions,
flags,
};
return this;
Expand Down
1 change: 1 addition & 0 deletions src/structures/Webhook.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ class Webhook {
* @property {boolean} [tts=false] Whether or not the message should be spoken aloud
* @property {string} [nonce=''] The nonce for the message
* @property {Object[]} [embeds] An array of embeds for the message
* @property {MessageMentionOptions} [allowedMentions] Which mentions should be parsed from the message content
* (see [here](https://discordapp.com/developers/docs/resources/channel#embed-object) for more details)
* @property {'none' | 'all' | 'everyone'} [disableMentions=this.client.options.disableMentions] Whether or not
* all mentions or everyone/here mentions should be sanitized to prevent unexpected mentions
Expand Down
1 change: 1 addition & 0 deletions src/structures/interfaces/TextBasedChannel.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ class TextBasedChannel {
* @property {string} [content=''] The content for the message
* @property {MessageEmbed|Object} [embed] An embed for the message
* (see [here](https://discordapp.com/developers/docs/resources/channel#embed-object) for more details)
* @property {MessageMentionOptions} [allowedMentions] Which mentions should be parsed from the message content
monbrey marked this conversation as resolved.
Show resolved Hide resolved
* @property {'none' | 'all' | 'everyone'} [disableMentions=this.client.options.disableMentions] Whether or not
* all mentions or everyone/here mentions should be sanitized to prevent unexpected mentions
* @property {FileOptions[]|BufferResolvable[]} [files] Files to send with the message
Expand Down
10 changes: 10 additions & 0 deletions typings/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2742,12 +2742,21 @@ declare module 'discord.js' {

type MessageFlagsString = 'CROSSPOSTED' | 'IS_CROSSPOST' | 'SUPPRESS_EMBEDS' | 'SOURCE_MESSAGE_DELETED' | 'URGENT';

interface MessageMentionOptions {
parse?: MessageMentionTypes[];
roles?: Snowflake[];
users?: Snowflake[];
SpaceEEC marked this conversation as resolved.
Show resolved Hide resolved
}

type MessageMentionTypes = 'roles' | 'users' | 'everyone';

interface MessageOptions {
tts?: boolean;
nonce?: string;
content?: string;
embed?: MessageEmbed | MessageEmbedOptions;
disableMentions?: 'none' | 'all' | 'everyone';
allowedMentions?: MessageMentionOptions;
files?: (FileOptions | BufferResolvable | Stream | MessageAttachment)[];
code?: string | boolean;
split?: boolean | SplitOptions;
Expand Down Expand Up @@ -2994,6 +3003,7 @@ declare module 'discord.js' {
nonce?: string;
embeds?: (MessageEmbed | object)[];
disableMentions?: 'none' | 'all' | 'everyone';
allowedMentions?: MessageMentionOptions;
files?: (FileOptions | BufferResolvable | Stream | MessageAttachment)[];
code?: string | boolean;
split?: boolean | SplitOptions;
Expand Down