@gatekeeper_technology/excel-utils 1.0.6 → 1.0.8

package/README.md

@@ -1,9 +1,13 @@
 # Gatekeeper's Excel Utils
 
 ## Changelog
-### [1.00.06] 18-03-2022
-### Changed
-- Updated the structure of the package.
+### [1.00.08] 24-08-2022
+### Added
+- Ability to get worksheet by name.
+- Ability to get worksheet by index.
+### [1.00.07] 24-08-2022
+### Fixed
+- Fixed bug where workbook_creator class was not exported properly. 
 ### [1.00.05] 18-03-2022
 ### Changed
 - Fixed import bug

package/index.js

@@ -1,7 +1,7 @@
-const utils = require("./utils");
-const WorkbookCreator = require("./workbook_creator");
+const workbookCreator = require("./workbook_creator.js");
+const utils = require("./utils.js");
 
 module.exports = {
     utils,
-    WorkbookCreator
+    workbookCreator
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gatekeeper_technology/excel-utils",
-    "version": "1.0.6",
+    "version": "1.0.8",
     "description": "Gatekeeper's excel Utils - shared in NPM",
     "author": "David Holtzhausen",
     "main": "index.js",

package/utils.js

@@ -1,7 +1,7 @@
-const WorkbookCreator = require("./workbook_creator");
+const WorkbookCreator = require("./workbook_creator.js");
 
 async function generateXLSXBuffer(data, sheet_name) {
-    const workbook_creator = new WorkbookCreator.WorkbookCreator();
+    const workbook_creator = new WorkbookCreator();
     let _workbook = workbook_creator.createWorkbook();
     let _worksheet = workbook_creator.createWorksheet(_workbook, sheet_name);
     workbook_creator.loadDataIntoWorksheet(_worksheet, data);
@@ -13,7 +13,7 @@ async function generateXLSXBuffer(data, sheet_name) {
  * Returns an array of all 
  */
 async function getWorkbookData(data) {
-    const workbook_creator = new WorkbookCreator.WorkbookCreator();
+    const workbook_creator = new WorkbookCreator();
     let _workbook = await workbook_creator.loadXLSX(data);
     let _worksheet = _workbook.worksheets[0];
 
@@ -28,4 +28,4 @@ async function getWorkbookData(data) {
 module.exports = {
     generateXLSXBuffer,
     getWorkbookData
-}
+}

package/workbook_creator.js

@@ -1,7 +1,9 @@
 const ExcelJS = require("exceljs");
 
-class WorkbookCreator {
-    constructor() { }
+let WorkbookCreator = class {
+    constructor() {
+
+    }
     /**
      * Create a new workbook
      * @returns {ExcelJS.Workbook} The created workbook
@@ -122,8 +124,26 @@ class WorkbookCreator {
         };
     }
 
+    /**
+     * Gets worksheet with specified name within workbook
+     * @param {ExcelJS.Workbook} workbook
+     * @param {string} worksheet_name
+     * @returns {ExcelJS.Worksheet} Worksheet with specified name
+     */
+    getWorksheetByName(workbook, worksheet_name) {
+        return workbook.getWorksheet(worksheet_name);
+    }
+
+    /**
+     * Gets worksheet at specified index within workbook
+     * @param {ExcelJS.Workbook} workbook
+     * @param {number} index
+     * @returns {ExcelJS.Worksheet} Worksheet at specified index
+     */
+     getWorksheetByIndex(workbook, worksheet_index) {
+        return workbook.worksheets[worksheet_index];
+    }
+
 }
 
-module.exports = {
-    WorkbookCreator
-}
+module.exports = WorkbookCreator;