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

docs: Update rule trigger types (#9708)

Browse Source 
docs: update rule trigger types
This commit is contained in:
Jiralite
2024-06-07 23:04:56 +01:00
committed by GitHub
parent 599ad3eab5
commit 757bed0b1f
2 changed files with 13 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
packages/discord.js/src/managers/AutoModerationRuleManager.js
View File

@@ -57,7 +57,9 @@ class AutoModerationRuleManager extends CachedManager {
* @property {AutoModerationRuleKeywordPresetType[]} [presets] * @property {AutoModerationRuleKeywordPresetType[]} [presets]
* The internally pre-defined wordsets which will be searched for in the content * The internally pre-defined wordsets which will be searched for in the content
* @property {string[]} [allowList] The substrings that will be exempt from triggering * @property {string[]} [allowList] The substrings that will be exempt from triggering
* {@link AutoModerationRuleTriggerType.Keyword} and {@link AutoModerationRuleTriggerType.KeywordPreset} * {@link AutoModerationRuleTriggerType.Keyword},
* {@link AutoModerationRuleTriggerType.KeywordPreset},
* and {@link AutoModerationRuleTriggerType.MemberProfile}
* @property {?number} [mentionTotalLimit] The total number of role & user mentions allowed per message * @property {?number} [mentionTotalLimit] The total number of role & user mentions allowed per message
* @property {boolean} [mentionRaidProtectionEnabled] Whether to automatically detect mention raids * @property {boolean} [mentionRaidProtectionEnabled] Whether to automatically detect mention raids
*/ */
@@ -87,8 +89,10 @@ class AutoModerationRuleManager extends CachedManager {
* @property {AutoModerationRuleTriggerType} triggerType The trigger type of the auto moderation rule * @property {AutoModerationRuleTriggerType} triggerType The trigger type of the auto moderation rule
* @property {AutoModerationTriggerMetadataOptions} [triggerMetadata] The trigger metadata of the auto moderation rule * @property {AutoModerationTriggerMetadataOptions} [triggerMetadata] The trigger metadata of the auto moderation rule
* <info>This property is required if using a `triggerType` of * <info>This property is required if using a `triggerType` of
* {@link AutoModerationRuleTriggerType.Keyword}, {@link AutoModerationRuleTriggerType.KeywordPreset}, * {@link AutoModerationRuleTriggerType.Keyword},
* or {@link AutoModerationRuleTriggerType.MentionSpam}.</info> * {@link AutoModerationRuleTriggerType.KeywordPreset},
* {@link AutoModerationRuleTriggerType.MentionSpam},
* or {@link AutoModerationRuleTriggerType.MemberProfile}.</info>
* @property {AutoModerationActionOptions[]} actions * @property {AutoModerationActionOptions[]} actions
* The actions that will execute when the auto moderation rule is triggered * The actions that will execute when the auto moderation rule is triggered
* @property {boolean} [enabled] Whether the auto moderation rule should be enabled * @property {boolean} [enabled] Whether the auto moderation rule should be enabled

8
packages/discord.js/src/structures/AutoModerationRule.js
View File

@@ -66,7 +66,9 @@ class AutoModerationRule extends Base {
* @property {AutoModerationRuleKeywordPresetType[]} presets * @property {AutoModerationRuleKeywordPresetType[]} presets
* The internally pre-defined wordsets which will be searched for in the content * The internally pre-defined wordsets which will be searched for in the content
* @property {string[]} allowList The substrings that will be exempt from triggering * @property {string[]} allowList The substrings that will be exempt from triggering
* {@link AutoModerationRuleTriggerType.Keyword} and {@link AutoModerationRuleTriggerType.KeywordPreset} * {@link AutoModerationRuleTriggerType.Keyword},
* {@link AutoModerationRuleTriggerType.KeywordPreset},
* and {@link AutoModerationRuleTriggerType.MemberProfile}
* @property {?number} mentionTotalLimit The total number of role & user mentions allowed per message * @property {?number} mentionTotalLimit The total number of role & user mentions allowed per message
* @property {boolean} mentionRaidProtectionEnabled Whether mention raid protection is enabled * @property {boolean} mentionRaidProtectionEnabled Whether mention raid protection is enabled
*/ */
@@ -209,7 +211,9 @@ class AutoModerationRule extends Base {
/** /**
* Sets the allow list for this auto moderation rule. * Sets the allow list for this auto moderation rule.
* @param {string[]} allowList The substrings that will be exempt from triggering * @param {string[]} allowList The substrings that will be exempt from triggering
* {@link AutoModerationRuleTriggerType.Keyword} and {@link AutoModerationRuleTriggerType.KeywordPreset} * {@link AutoModerationRuleTriggerType.Keyword},
* {@link AutoModerationRuleTriggerType.KeywordPreset},
* and {@link AutoModerationRuleTriggerType.MemberProfile}
* @param {string} [reason] The reason for changing the allow list of this auto moderation rule * @param {string} [reason] The reason for changing the allow list of this auto moderation rule
* @returns {Promise<AutoModerationRule>} * @returns {Promise<AutoModerationRule>}
*/ */