docs: updates on workflows

Added information on documentation

Author: ADMSK\AVROGAL1

.gitignore

@@ -17,6 +17,9 @@
 *.rar
 **/.DS_Store
 
+# License files
+licenses.json
+
 # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
 hs_err_pid*
 

dist/index.js

@@ -1,5 +1,5 @@
 import { MakeDirectoryOptions } from 'fs';
-import { ConfigOptions } from '../../typings/types';
+import { ConfigOptions } from '../../typings/domain-types';
 export declare const ensureDirExists: (dir: string, options?: MakeDirectoryOptions) => void;
 export declare const getDataAsJson: (fileName: string) => ConfigOptions[];
 export declare const storeDataAsJson: (filePath: string, fileName: string, data: any) => Promise<boolean>;

dist/src/utils/files.d.ts

@@ -4,11 +4,29 @@ import { JsonMode } from './enum-types';
  * @desc Type representing configuration options
  */
 export declare type ConfigOptions = {
+    /**
+     * Source file to process
+     */
     readonly sourceFile?: string;
+    /**
+     * Target path to store processed files
+     */
     readonly targetPath?: string;
+    /**
+     * Target file name
+     */
     readonly targetFile?: string;
+    /**
+     * Supported json mode (unique/duplicate)
+     */
     readonly jsonMode?: JsonMode;
+    /**
+     * Json path to fetch data from
+     */
     readonly jsonPath?: string;
+    /**
+     * Array of json fields to process
+     */
     readonly jsonFields?: string[];
 };
-//# sourceMappingURL=types.d.ts.map
+//# sourceMappingURL=domain-types.d.ts.map

dist/src/utils/files.d.ts.map

@@ -1,8 +1,15 @@
 /**
- * JSON mode type
+ * JsonMode
+ * @desc Type representing json operation modes
  */
 export declare enum JsonMode {
+    /**
+     * Only unique strings processed
+     */
     unique = "unique",
+    /**
+     * Only duplicate strings processed
+     */
     duplicate = "duplicate"
 }
 //# sourceMappingURL=enum-types.d.ts.map

dist/typings/types.d.ts dist/typings/domain-types.d.tsdist/typings/types.d.ts renamed to dist/typings/domain-types.d.ts

@@ -11,12 +11,18 @@ export declare type Optional<T> = T | null | undefined;
  */
 export declare type BiPredicate<T> = (a: T, b: T) => boolean;
 /**
- * Comparator types
+ * Comparator
+ * @desc Type representing comparator function
  */
 export declare type Comparator<T> = (a: T, b: T) => number;
+/**
+ * PropertyComparator
+ * @desc Type representing property comparator function
+ */
 export declare type PropertyComparator<T> = (a: T, b: T, value: string) => number;
 /**
- * Comparator modes
+ * ComparatorMode
+ * @desc Type representing supported comparator modes
  */
 export declare type ComparatorMode = 'asc' | 'desc';
 //# sourceMappingURL=standard-types.d.ts.map