Skip to content

Commit 757bed0

Browse files
authored
docs: Update rule trigger types (#9708)
docs: update rule trigger types
1 parent 599ad3e commit 757bed0

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

packages/discord.js/src/managers/AutoModerationRuleManager.js

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,9 @@ class AutoModerationRuleManager extends CachedManager {
5757
* @property {AutoModerationRuleKeywordPresetType[]} [presets]
5858
* The internally pre-defined wordsets which will be searched for in the content
5959
* @property {string[]} [allowList] The substrings that will be exempt from triggering
60-
* {@link AutoModerationRuleTriggerType.Keyword} and {@link AutoModerationRuleTriggerType.KeywordPreset}
60+
* {@link AutoModerationRuleTriggerType.Keyword},
61+
* {@link AutoModerationRuleTriggerType.KeywordPreset},
62+
* and {@link AutoModerationRuleTriggerType.MemberProfile}
6163
* @property {?number} [mentionTotalLimit] The total number of role & user mentions allowed per message
6264
* @property {boolean} [mentionRaidProtectionEnabled] Whether to automatically detect mention raids
6365
*/
@@ -87,8 +89,10 @@ class AutoModerationRuleManager extends CachedManager {
8789
* @property {AutoModerationRuleTriggerType} triggerType The trigger type of the auto moderation rule
8890
* @property {AutoModerationTriggerMetadataOptions} [triggerMetadata] The trigger metadata of the auto moderation rule
8991
* <info>This property is required if using a `triggerType` of
90-
* {@link AutoModerationRuleTriggerType.Keyword}, {@link AutoModerationRuleTriggerType.KeywordPreset},
91-
* or {@link AutoModerationRuleTriggerType.MentionSpam}.</info>
92+
* {@link AutoModerationRuleTriggerType.Keyword},
93+
* {@link AutoModerationRuleTriggerType.KeywordPreset},
94+
* {@link AutoModerationRuleTriggerType.MentionSpam},
95+
* or {@link AutoModerationRuleTriggerType.MemberProfile}.</info>
9296
* @property {AutoModerationActionOptions[]} actions
9397
* The actions that will execute when the auto moderation rule is triggered
9498
* @property {boolean} [enabled] Whether the auto moderation rule should be enabled

packages/discord.js/src/structures/AutoModerationRule.js

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,9 @@ class AutoModerationRule extends Base {
6666
* @property {AutoModerationRuleKeywordPresetType[]} presets
6767
* The internally pre-defined wordsets which will be searched for in the content
6868
* @property {string[]} allowList The substrings that will be exempt from triggering
69-
* {@link AutoModerationRuleTriggerType.Keyword} and {@link AutoModerationRuleTriggerType.KeywordPreset}
69+
* {@link AutoModerationRuleTriggerType.Keyword},
70+
* {@link AutoModerationRuleTriggerType.KeywordPreset},
71+
* and {@link AutoModerationRuleTriggerType.MemberProfile}
7072
* @property {?number} mentionTotalLimit The total number of role & user mentions allowed per message
7173
* @property {boolean} mentionRaidProtectionEnabled Whether mention raid protection is enabled
7274
*/
@@ -209,7 +211,9 @@ class AutoModerationRule extends Base {
209211
/**
210212
* Sets the allow list for this auto moderation rule.
211213
* @param {string[]} allowList The substrings that will be exempt from triggering
212-
* {@link AutoModerationRuleTriggerType.Keyword} and {@link AutoModerationRuleTriggerType.KeywordPreset}
214+
* {@link AutoModerationRuleTriggerType.Keyword},
215+
* {@link AutoModerationRuleTriggerType.KeywordPreset},
216+
* and {@link AutoModerationRuleTriggerType.MemberProfile}
213217
* @param {string} [reason] The reason for changing the allow list of this auto moderation rule
214218
* @returns {Promise<AutoModerationRule>}
215219
*/

0 commit comments

Comments
 (0)