Update documentation

1 files changed, 38 insertions, 20 deletions

diff --git a/app/lib/enum.js b/app/lib/enum.js
index 1815a551f7..a27bd37439 100644
--- a/app/lib/enum.js
+++ b/app/lib/enum.js
@@ -1,28 +1,46 @@
 /**
- * Creates enum object with keys provided as arguments
- * 
- * @constructor
- * @type Enum
- * @property {bool} isValid({string}) whether key is valid
- * @param {...string} ...  Enum keys
- * @export
- * @returns Enum
+ * Enum
+ * @exports
+ * @class Enum
  */
-export default function Enum() {
-  let object = Object.create({});
-  const keys = [...arguments];
+export default class Enum {
 
-  for(const key of keys) {
-    Object.defineProperty(object, key, {
-      enumerable: true,
-      value: key,
+  /**
+   * Creates an instance of EnumBase.
+   * 
+   * @param {...string} ... - enum keys
+   * @memberOf Enum
+   */
+  constructor() {
+    const keys = [...arguments];
+
+    for(const key of keys) {
+      Object.defineProperty(this, key, {
+        enumerable: true,
+        value: key,
+        writable: false
+      });
+    }
+
+    Object.defineProperty(this, 'allKeys', {
+      enumerable: false,
+      value: keys,
       writable: false
     });
+
+    Object.freeze(this);
   }
-  
-  Object.defineProperty(object, 'isValid', {
-    value: (e) => keys.includes(e)
-  });
 
-  return Object.freeze(object);
+  /**
+   * Check if key is registered in this enum
+   * 
+   * @param {string} key 
+   * @returns {bool}
+   * 
+   * @memberOf Enum
+   */
+  isValid(key) { 
+    return this.allKeys.includes(key); 
+  }
 }
+