@cj-tech-master/excelts 1.4.5-canary.20251212064440.3eb099f → 1.4.5-canary.20251212160853.7621827

package/dist/cjs/doc/column.js

@@ -5,9 +5,11 @@ const col_cache_js_1 = require("../utils/col-cache");
 const under_dash_js_1 = require("../utils/under-dash");
 const enums_js_1 = require("./enums");
 const DEFAULT_COLUMN_WIDTH = 9;
-// Column defines the column properties for 1 column.
-// This includes header rows, widths, key, (style), etc.
-// Worksheet will condense the columns as appropriate during serialization
+/**
+ * Column defines the column properties for 1 column.
+ * This includes header rows, widths, key, (style), etc.
+ * Worksheet will condense the columns as appropriate during serialization
+ */
 class Column {
     constructor(worksheet, number, defn) {
         this._worksheet = worksheet;
@@ -23,6 +25,9 @@ class Column {
     get worksheet() {
         return this._worksheet;
     }
+    /**
+     * Column letter key
+     */
     get letter() {
         return col_cache_js_1.colCache.n2l(this._number);
     }
@@ -71,6 +76,9 @@ class Column {
         }
         return [];
     }
+    /**
+     * Can be a string to set one row high header or an array to set multi-row high header
+     */
     get header() {
         return this._header;
     }
@@ -85,6 +93,9 @@ class Column {
             this._header = undefined;
         }
     }
+    /**
+     * The name of the properties associated with this column in each row
+     */
     get key() {
         return this._key;
     }
@@ -98,18 +109,27 @@ class Column {
             this._worksheet.setColumnKey(this._key, this);
         }
     }
+    /**
+     * Hides the column
+     */
     get hidden() {
         return !!this._hidden;
     }
     set hidden(value) {
         this._hidden = value;
     }
+    /**
+     * Set an outline level for columns
+     */
     get outlineLevel() {
         return this._outlineLevel || 0;
     }
     set outlineLevel(value) {
         this._outlineLevel = value;
     }
+    /**
+     * Indicate the collapsed state based on outlineLevel
+     */
     get collapsed() {
         return !!(this._outlineLevel && this._outlineLevel >= this._worksheet.properties.outlineLevelCol);
     }
@@ -151,16 +171,25 @@ class Column {
     get headerCount() {
         return this.headers.length;
     }
-    eachCell(options, iteratee) {
+    eachCell(optionsOrCallback, maybeCallback) {
         const colNumber = this.number;
-        if (!iteratee) {
-            iteratee = options;
+        let options;
+        let callback;
+        if (typeof optionsOrCallback === "function") {
             options = {};
+            callback = optionsOrCallback;
+        }
+        else {
+            options = optionsOrCallback;
+            callback = maybeCallback;
         }
         this._worksheet.eachRow(options, (row, rowNumber) => {
-            iteratee(row.getCell(colNumber), rowNumber);
+            callback(row.getCell(colNumber), rowNumber);
         });
     }
+    /**
+     * The cell values in the column
+     */
     get values() {
         const v = [];
         this.eachCell((cell, rowNumber) => {

package/dist/cjs/doc/row.js

@@ -12,19 +12,29 @@ class Row {
         this.style = {};
         this.outlineLevel = 0;
     }
-    // return the row number
+    /**
+     * The row number
+     */
     get number() {
         return this._number;
     }
+    /**
+     * The worksheet that contains this row
+     */
     get worksheet() {
         return this._worksheet;
     }
-    // Inform Streaming Writer that this row (and all rows before it) are complete
-    // and ready to write. Has no effect on Worksheet document
+    /**
+     * Commit a completed row to stream.
+     * Inform Streaming Writer that this row (and all rows before it) are complete
+     * and ready to write. Has no effect on Worksheet document.
+     */
     commit() {
         this._worksheet._commitRow(this);
     }
-    // helps GC by breaking cyclic references
+    /**
+     * Helps GC by breaking cyclic references
+     */
     destroy() {
         delete this._worksheet;
         delete this._cells;
@@ -43,7 +53,9 @@ class Row {
         }
         return cell;
     }
-    // get cell by key, letter or column number
+    /**
+     * Get cell by number, column letter or column key
+     */
     getCell(col) {
         let colNum;
         if (typeof col === "string") {
@@ -66,7 +78,11 @@ class Row {
                 col: colNum
             }));
     }
-    // remove cell(s) and shift all higher cells down by count
+    /**
+     * Cut one or more cells (cells to the right are shifted left)
+     *
+     * Note: this operation will not affect other rows
+     */
     splice(start, count, ...inserts) {
         const nKeep = start + count;
         const nExpand = inserts.length - count;
@@ -115,26 +131,26 @@ class Row {
             cDst.comment = undefined;
         }
     }
-    eachCell(optionsOrIteratee, maybeIteratee) {
+    eachCell(optOrCallback, maybeCallback) {
         let options = null;
-        let iteratee;
-        if (typeof optionsOrIteratee === "function") {
-            iteratee = optionsOrIteratee;
+        let callback;
+        if (typeof optOrCallback === "function") {
+            callback = optOrCallback;
         }
         else {
-            options = optionsOrIteratee;
-            iteratee = maybeIteratee;
+            options = optOrCallback;
+            callback = maybeCallback;
         }
         if (options && options.includeEmpty) {
             const n = this._cells.length;
             for (let i = 1; i <= n; i++) {
-                iteratee(this.getCell(i), i);
+                callback(this.getCell(i), i);
             }
         }
         else {
             this._cells.forEach((cell, index) => {
                 if (cell && cell.type !== enums_js_1.Enums.ValueType.Null) {
-                    iteratee(cell, index + 1);
+                    callback(cell, index + 1);
                 }
             });
         }
@@ -155,7 +171,9 @@ class Row {
         }
         ws.rowBreaks.push(pb);
     }
-    // return a sparse array of cell values
+    /**
+     * Get a row as a sparse array
+     */
     get values() {
         const values = [];
         this._cells.forEach(cell => {
@@ -165,7 +183,9 @@ class Row {
         });
         return values;
     }
-    // set the values by contiguous or sparse array, or by key'd object literal
+    /**
+     * Set the values by contiguous or sparse array, or by key'd object literal
+     */
     set values(value) {
         // this operation is not additive - any prior cells are removed
         this._cells = [];
@@ -201,13 +221,21 @@ class Row {
             });
         }
     }
-    // returns true if the row includes at least one cell with a value
+    /**
+     * Returns true if the row includes at least one cell with a value
+     */
     get hasValues() {
         return this._cells.some(cell => cell && cell.type !== enums_js_1.Enums.ValueType.Null);
     }
+    /**
+     * Number of cells including empty ones
+     */
     get cellCount() {
         return this._cells.length;
     }
+    /**
+     * Number of non-empty cells
+     */
     get actualCellCount() {
         let count = 0;
         this.eachCell(() => {
@@ -215,7 +243,9 @@ class Row {
         });
         return count;
     }
-    // get the min and max column number for the non-null cells in this row or null
+    /**
+     * Get the min and max column number for the non-null cells in this row or null
+     */
     get dimensions() {
         let min = 0;
         let max = 0;

package/dist/cjs/doc/workbook.js

@@ -29,12 +29,18 @@ class Workbook {
         this.pivotTables = [];
         this._definedNames = new defined_names_js_1.DefinedNames();
     }
+    /**
+     * xlsx file format operations
+     */
     get xlsx() {
         if (!this._xlsx) {
             this._xlsx = new xlsx_js_1.XLSX(this);
         }
         return this._xlsx;
     }
+    /**
+     * csv file format operations
+     */
     get csv() {
         if (!this._csv) {
             this._csv = new csv_js_1.CSV(this);
@@ -50,6 +56,9 @@ class Workbook {
         }
         return this._worksheets.length || 1;
     }
+    /**
+     * Add a new worksheet and return a reference to it
+     */
     addWorksheet(name, options) {
         const id = this.nextId;
         const lastOrderNo = this._worksheets.reduce((acc, ws) => ((ws && ws.orderNo) > acc ? ws.orderNo : acc), 0);
@@ -73,6 +82,9 @@ class Workbook {
             worksheet.destroy();
         }
     }
+    /**
+     * Fetch sheet by name or id
+     */
     getWorksheet(id) {
         if (id === undefined) {
             return this._worksheets.find(Boolean);
@@ -85,6 +97,9 @@ class Workbook {
         }
         return undefined;
     }
+    /**
+     * Return a clone of worksheets in order
+     */
     get worksheets() {
         // return a clone of _worksheets
         return this._worksheets
@@ -92,9 +107,14 @@ class Workbook {
             .sort((a, b) => a.orderNo - b.orderNo)
             .filter(Boolean);
     }
-    eachSheet(iteratee) {
+    /**
+     * Iterate over all sheets.
+     *
+     * Note: `workbook.worksheets.forEach` will still work but this is better.
+     */
+    eachSheet(callback) {
         this.worksheets.forEach(sheet => {
-            iteratee(sheet, sheet.id);
+            callback(sheet, sheet.id);
         });
     }
     get definedNames() {
@@ -104,6 +124,9 @@ class Workbook {
         // Note: themes are not an exposed feature, meddle at your peril!
         this._themes = undefined;
     }
+    /**
+     * Add Image to Workbook and return the id
+     */
     addImage(image) {
         // TODO:  validation?
         const id = this.media.length;