feat(Config): add doc typings

ExploratoryEngineering · May 13, 2018 · 8265ab7 · 8265ab7
1 parent 66849b2
commit 8265ab7
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/src/Config.ts b/src/Config.ts
@@ -5,6 +5,9 @@ export { IHexToFloatConfig } from "./mappers/HexToFloat";
 export { IHexToIntConfig } from "./mappers/HexToInt";
 export { IOffsetConfig } from "./mappers/Offset";
 
+/**
+ * Endianness used as config parameter
+ */
 export enum Endianness {
   /**
    * Config parameter for defining little endianness
@@ -16,8 +19,17 @@ export enum Endianness {
   BIG_ENDIAN = "be",
 }
 
+/**
+ * Base64Action used as config parameter
+ */
 export enum Base64Action {
+  /**
+   * Config parameter for defining encoding in Base64
+   */
   ENCODE = "encode",
+  /**
+   * Config parameter for defining decoding in Base64
+   */
   DECODE = "decode",
 }