@niicojs/excel 0.2.2 → 0.2.3

package/dist/index.d.ts

@@ -168,6 +168,39 @@ interface RichCellValue {
     /** Cell style */
     style?: CellStyle;
 }
+/**
+ * Configuration for converting a sheet to JSON objects.
+ */
+interface SheetToJsonConfig {
+    /**
+     * Field names to use for each column.
+     * If provided, the first row of data starts at row 1 (or startRow).
+     * If not provided, the first row is used as field names.
+     */
+    fields?: string[];
+    /**
+     * Starting row (0-based). Defaults to 0.
+     * If fields are not provided, this row contains the headers.
+     * If fields are provided, this is the first data row.
+     */
+    startRow?: number;
+    /**
+     * Starting column (0-based). Defaults to 0.
+     */
+    startCol?: number;
+    /**
+     * Ending row (0-based, inclusive). Defaults to the last row with data.
+     */
+    endRow?: number;
+    /**
+     * Ending column (0-based, inclusive). Defaults to the last column with data.
+     */
+    endCol?: number;
+    /**
+     * If true, stop reading when an empty row is encountered. Defaults to true.
+     */
+    stopOnEmptyRow?: boolean;
+}
 
 /**
  * Represents a single cell in a worksheet
@@ -377,6 +410,29 @@ declare class Worksheet {
      * Get all cells in the worksheet
      */
     get cells(): Map<string, Cell>;
+    /**
+     * Convert sheet data to an array of JSON objects.
+     *
+     * @param config - Configuration options
+     * @returns Array of objects where keys are field names and values are cell values
+     *
+     * @example
+     * ```typescript
+     * // Using first row as headers
+     * const data = sheet.toJson();
+     *
+     * // Using custom field names
+     * const data = sheet.toJson({ fields: ['name', 'age', 'city'] });
+     *
+     * // Starting from a specific row/column
+     * const data = sheet.toJson({ startRow: 2, startCol: 1 });
+     * ```
+     */
+    toJson<T = Record<string, CellValue>>(config?: SheetToJsonConfig): T[];
+    /**
+     * Get the bounds of data in the sheet (min/max row and column with data)
+     */
+    private _getDataBounds;
     /**
      * Generate XML for this worksheet
      */
@@ -836,5 +892,5 @@ declare const parseRange: (range: string) => RangeAddress;
 declare const toRange: (range: RangeAddress) => string;
 
 export { Cell, PivotCache, PivotTable, Range, SharedStrings, Styles, Workbook, Worksheet, parseAddress, parseRange, toAddress, toRange };
-export type { AggregationType, Alignment, BorderStyle, BorderType, CellAddress, CellError, CellStyle, CellType, CellValue, ColumnConfig, ErrorType, PivotFieldAxis, PivotTableConfig, PivotValueConfig, RangeAddress, RichCellValue, SheetFromDataConfig };
+export type { AggregationType, Alignment, BorderStyle, BorderType, CellAddress, CellError, CellStyle, CellType, CellValue, ColumnConfig, ErrorType, PivotFieldAxis, PivotTableConfig, PivotValueConfig, RangeAddress, RichCellValue, SheetFromDataConfig, SheetToJsonConfig };
 //# sourceMappingURL=index.d.ts.map