excel-csv-handler 1.0.5 → 1.0.8

package/README.md

@@ -14,7 +14,16 @@ npm install excel-csv-handler
 import ExcelCsvHandler from 'excel-csv-handler';
 
 const handler = new ExcelCsvHandler();
-await handler.write('output.csv', [{ name: '张三', age: 25 }]);
-const data = await handler.read('output.csv');
+await handler.write('./output.csv', [{ name: '张三', age: 25 }]);
+const data = await handler.read('./output.csv');
+console.log(data);
+```
+
+```javascript
+import ExcelCsvHandler from 'excel-csv-handler';
+
+const handler = new ExcelCsvHandler();
+await handler.write('output.xlsx', [{ name: '张三', age: 25 }]);
+const data = await handler.read('output.xlsx');
 console.log(data);
 ```

package/package.json

@@ -1,26 +1,26 @@
 {
-	"name": "excel-csv-handler",
-	"version": "1.0.5",
-	"description": "A Node.js utility to read/write Excel and CSV files with GBK encoding support",
-	"main": "src/index.js",
-	"types": "src/excel-csv-handler.d.ts",
-	"type": "module",
-	"scripts": {
-		"test": "echo \"Error: no test specified\" && exit 1"
-	},
-	"keywords": [
-		"excel",
-		"csv",
-		"xlsx",
-		"gbk",
-		"node",
-		"file"
-	],
-	"author": "Chao_bei",
-	"license": "MIT",
-	"dependencies": {
-		"fast-csv": "^5.0.5",
-		"iconv-lite": "^0.7.0",
-		"xlsx": "^0.18.5"
-	}
-}
+  "name": "excel-csv-handler",
+  "version": "1.0.8",
+  "description": "A Node.js utility to read/write Excel and CSV files with GBK encoding support",
+  "main": "src/index.js",
+  "types": "src/excel-csv-handler.d.ts",
+  "type": "module",
+  "keywords": [
+    "excel",
+    "csv",
+    "xlsx",
+    "gbk",
+    "node",
+    "file"
+  ],
+  "author": "Chao_bei",
+  "license": "MIT",
+  "dependencies": {
+    "fast-csv": "^5.0.5",
+    "iconv-lite": "^0.7.0",
+    "xlsx": "^0.18.5"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  }
+}

package/src/index.js

@@ -28,16 +28,17 @@ class ExcelCsvHandler {
     }
 
     /**
-     * 写入 Excel 或 CSV 文件（以 GBK 编码保存 CSV，Excel 保持默认）
-     * @param {string} filePath - 文件路径
-     * @param {Array<Object>} data - 要写入的数据
-     * @param {Array<string>} headers - 可选列顺序
-     */
-    async write(filePath, data, headers = null) {
+ * 写入 Excel 或 CSV 文件（以 GBK 编码保存 CSV，Excel 保持默认）
+ * @param {string} filePath - 文件路径
+ * @param {Array<Object>} data - 要写入的数据
+ * @param {Array<string>} headers - 可选列顺序
+ * @param {string} sheetName - Excel sheet 名称（默认为 'Sheet1'）
+ */
+    async write(filePath, data, headers = null, sheetName = 'Sheet1') {
         const ext = path.extname(filePath).toLowerCase();
 
         if (ext === '.xlsx' || ext === '.xls') {
-            this.writeExcelFile(filePath, data, headers);
+            this.writeExcelFile(filePath, data, headers, sheetName);
         } else if (ext === '.csv') {
             await this.writeCsvFile(filePath, data, headers);
         } else {
@@ -79,7 +80,7 @@ class ExcelCsvHandler {
         });
     }
 
-    writeExcelFile(filePath, data, headers = null) {
+    writeExcelFile(filePath, data, headers = null, sheetName = 'Sheet1') {
         if (!headers && data.length > 0) {
             headers = Object.keys(data[0]);
         } else if (!headers) {
@@ -89,7 +90,7 @@ class ExcelCsvHandler {
         const wsData = [headers, ...data.map(row => headers.map(h => row[h] ?? ''))];
         const worksheet = XLSX.utils.aoa_to_sheet(wsData);
         const workbook = XLSX.utils.book_new();
-        XLSX.utils.book_append_sheet(workbook, worksheet, 'Sheet1');
+        XLSX.utils.book_append_sheet(workbook, worksheet, sheetName);
         XLSX.writeFile(workbook, filePath);
     }