feat(Guild): add enum for mfa_level (#5797)

discordjs · Jun 10, 2021 · ffabec3 · ffabec3
1 parent 2f5424b
commit ffabec3
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 4 deletions.
diff --git a/src/structures/Guild.js b/src/structures/Guild.js
@@ -25,6 +25,7 @@ const {
   ExplicitContentFilterLevels,
   NSFWLevels,
   Status,
+  MFALevels,
 } = require('../util/Constants');
 const DataResolver = require('../util/DataResolver');
 const SystemChannelFlags = require('../util/SystemChannelFlags');
@@ -260,10 +261,10 @@ class Guild extends BaseGuild {
     this.explicitContentFilter = ExplicitContentFilterLevels[data.explicit_content_filter];
 
     /**
-     * The required MFA level for the guild
-     * @type {number}
+     * The required MFA level for this guild
+     * @type {MFALevel}
      */
-    this.mfaLevel = data.mfa_level;
+    this.mfaLevel = MFALevels[data.mfa_level];
 
     /**
      * The timestamp the client user joined the guild at

diff --git a/src/util/Constants.js b/src/util/Constants.js
@@ -867,6 +867,14 @@ exports.MessageComponentTypes = createEnum([null, 'ACTION_ROW', 'BUTTON']);
  */
 exports.MessageButtonStyles = createEnum([null, 'PRIMARY', 'SECONDARY', 'SUCCESS', 'DANGER', 'LINK']);
 
+/**
+ * The required MFA level for a guild
+ * * NONE
+ * * ELEVATED
+ * @typedef {string} MFALevel
+ */
+exports.MFALevels = createEnum(['NONE', 'ELEVATED']);
+
 /**
  * NSFW level of a Guild
  * * DEFAULT

diff --git a/typings/index.d.ts b/typings/index.d.ts
@@ -53,6 +53,11 @@ declare enum MessageComponentTypes {
   BUTTON = 2,
 }
 
+declare enum MFALevels {
+  NONE = 0,
+  ELEVATED = 1,
+}
+
 declare enum NSFWLevels {
   DEFAULT = 0,
   EXPLICIT = 1,
@@ -681,6 +686,7 @@ declare module 'discord.js' {
     InteractionResponseTypes: typeof InteractionResponseTypes;
     MessageComponentTypes: typeof MessageComponentTypes;
     MessageButtonStyles: typeof MessageButtonStyles;
+    MFALevels: typeof MFALevels;
     NSFWLevels: typeof NSFWLevels;
   };
 
@@ -759,7 +765,7 @@ declare module 'discord.js' {
     public readonly me: GuildMember | null;
     public memberCount: number;
     public members: GuildMemberManager;
-    public mfaLevel: number;
+    public mfaLevel: MFALevel;
     public nsfwLevel: NSFWLevel;
     public ownerID: Snowflake;
     public preferredLocale: string;
@@ -3388,6 +3394,8 @@ declare module 'discord.js' {
     | 'REPLY'
     | 'APPLICATION_COMMAND';
 
+  type MFALevel = keyof typeof MFALevels;
+
   type NSFWLevel = keyof typeof NSFWLevels;
 
   interface OverwriteData {