@gatekeeper_technology/excel-utils 1.0.8 → 1.0.10

package/README.md

@@ -1,6 +1,12 @@
 # Gatekeeper's Excel Utils
 
 ## Changelog
+### [1.00.10] 24-08-2022
+### Fixed
+- Bug with loadDataIntoWorksheetWithRowOffset function which did not load data correctly.
+### [1.00.09] 24-08-2022
+### Added
+- Ability to load data into worksheet with row offset.
 ### [1.00.08] 24-08-2022
 ### Added
 - Ability to get worksheet by name.

package/package.json

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

package/workbook_creator.js

@@ -34,9 +34,9 @@ let WorkbookCreator = class {
     }
 
     /**
-     * Create a new workbook
+     * Create a new Worksheet
      * @param {ExcelJS.Workbook} workbook Workbook
-     * @returns {ExcelJS.Worksheet} The created workbook
+     * @returns {ExcelJS.Worksheet} The created Worksheet
      */
     createWorksheet(workbook, worksheet_name) {
         const worksheet = workbook.addWorksheet(worksheet_name ? worksheet_name : 'sheet', {
@@ -62,6 +62,24 @@ let WorkbookCreator = class {
         return worksheet;
     }
 
+    /**
+     * Load data into worksheet with row offset
+     * @param {ExcelJS.Worksheet} worksheet Worksheet
+     * @param {string[][]} data Data array
+     * @param {number} offset Number of rows to skip before writing data
+     * @returns {ExcelJS.Worksheet} The created Worksheet
+     */
+    loadDataIntoWorksheetWithRowOffset(worksheet, data, row_offset) {
+        for (let [_index, _row_data] of data.entries()) {
+            let current_row_index = _index + row_offset
+            // Get a row object. If it doesn't already exist, a new empty one will be returned
+            let row = worksheet.getRow(current_row_index + 1);
+            row.values = _row_data;
+        }
+
+        return worksheet;
+    }
+
     /**
      * Save workbook as XLSX
      * @param {ExcelJS.Workbook} workbook Workbook