@nazarkalytiuk/rusc-xlsx 1.0.4 → 1.0.5

package/README.md

@@ -116,6 +116,8 @@ const worksheet = workbook.addWorksheetWithConstantMemory('Large');
 - **Memory**: Constant ~0.02 MB (regardless of size!)
 - **Limitations**: Sequential row writing only, no tables
 
+> **Important:** For large exports, use `addWorksheetWithConstantMemory()` with `save(filename)` — not `saveToBuffer()`. The constant memory mode flushes rows to temp files as they're written, but `saveToBuffer()` would load the entire result back into memory, defeating the purpose. Use `saveToStream()` if you need to pipe the output without disk I/O overhead.
+
 **Example: 1 million rows**
 ```javascript
 const workbook = new Workbook();
@@ -126,7 +128,7 @@ for (let row = 0; row < 1000000; row++) {
   worksheet.write(row, 1, row * 100);
 }
 
-workbook.save('large.xlsx');
+workbook.save('large.xlsx'); // Use save(), not saveToBuffer()
 ```
 
 ### Low Memory Mode
@@ -213,11 +215,26 @@ workbook.save('output.xlsx');
 
 See the `examples/` directory for complete examples:
 - `basic.js` - Simple workbook creation
-- `formatting.js` - Cell formatting
-- `advanced-features.js` - Charts, images, tables
-- `conditional-formatting-and-page-setup.js` - Conditional formatting
-- `constant-memory.js` - Large datasets
-- `typescript-example.ts` - TypeScript usage
+- `formatting.js` - Cell formatting and number formats
+- `data-types.js` - All supported data types
+- `datetime.js` - Date/time writing methods and formats
+- `multiple-sheets.js` - Working with multiple worksheets
+- `advanced-styling.js` - Fonts, borders, patterns, fills
+- `advanced-features.js` - Formulas, data validation, hyperlinks, freeze panes
+- `charts.js` - Column, line, pie, bar, and scatter charts
+- `tables.js` - Excel tables with totals, formulas, and styles
+- `images.js` - Inserting images from buffers with scaling and links
+- `sparklines.js` - Line, column, and win/lose sparklines
+- `rich-text.js` - Multi-format text within cells
+- `notes.js` - Cell comments with custom styling
+- `conditional-formatting-and-page-setup.js` - Conditional formatting and print setup
+- `protection.js` - Worksheet protection with granular permissions
+- `doc-properties.js` - Document metadata (author, title, etc.)
+- `constant-memory.js` - Large datasets with constant memory mode
+- `low-memory.js` - Large datasets with low memory mode
+- `save-to-buffer.js` - Saving to Buffer for HTTP responses
+- `typescript-example.ts` - Full TypeScript usage
+- `type-safety-demo.ts` - TypeScript type safety features
 
 ## Building from Source
 

package/index.d.ts

@@ -380,7 +380,7 @@ export declare class RuscTableColumn {
   /** Set the header name for the column */
   setHeader(header: string): this
   /** Set the total function for the column */
-  setTotalFunction(function: string): this
+  setTotalFunction(func: string): this
   /** Set a custom total label for the column */
   setTotalLabel(label: string): this
   /** Set a custom formula for the column */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nazarkalytiuk/rusc-xlsx",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Fast Excel XLSX library for Node.js powered by rust_xlsxwriter",
   "main": "wrapper.js",
   "types": "wrapper.d.ts",
@@ -69,12 +69,12 @@
     "node": ">=16"
   },
   "optionalDependencies": {
-    "@nazarkalytiuk/rusc-xlsx-win32-x64-msvc": "1.0.4",
-    "@nazarkalytiuk/rusc-xlsx-win32-ia32-msvc": "1.0.4",
-    "@nazarkalytiuk/rusc-xlsx-win32-arm64-msvc": "1.0.4",
-    "@nazarkalytiuk/rusc-xlsx-darwin-universal": "1.0.4",
-    "@nazarkalytiuk/rusc-xlsx-linux-x64-gnu": "1.0.4",
-    "@nazarkalytiuk/rusc-xlsx-linux-arm64-gnu": "1.0.4",
-    "@nazarkalytiuk/rusc-xlsx-linux-x64-musl": "1.0.4"
+    "@nazarkalytiuk/rusc-xlsx-win32-x64-msvc": "1.0.5",
+    "@nazarkalytiuk/rusc-xlsx-win32-ia32-msvc": "1.0.5",
+    "@nazarkalytiuk/rusc-xlsx-win32-arm64-msvc": "1.0.5",
+    "@nazarkalytiuk/rusc-xlsx-darwin-universal": "1.0.5",
+    "@nazarkalytiuk/rusc-xlsx-linux-x64-gnu": "1.0.5",
+    "@nazarkalytiuk/rusc-xlsx-linux-arm64-gnu": "1.0.5",
+    "@nazarkalytiuk/rusc-xlsx-linux-x64-musl": "1.0.5"
   }
 }

package/wrapper.d.ts

@@ -2242,6 +2242,26 @@ export declare class Workbook {
    */
   saveToBuffer(): Buffer;
 
+  /**
+   * Save the workbook to a Writable stream
+   *
+   * Streams XLSX data directly to the writable without buffering the entire
+   * file in memory. Combines the speed of `saveToBuffer()` with the low
+   * memory footprint of `save(filename)`.
+   *
+   * @param writable - A Node.js Writable stream (e.g., fs.createWriteStream, HTTP response)
+   * @example
+   * const fs = require('fs');
+   * const stream = fs.createWriteStream('output.xlsx');
+   * workbook.saveToStream(stream);
+   *
+   * @example
+   * // HTTP response
+   * res.setHeader('Content-Type', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet');
+   * workbook.saveToStream(res);
+   */
+  saveToStream(writable: import('stream').Writable): void;
+
   /**
    * Define a named range or formula
    * @param name - Name for the range (e.g., 'Sales' or 'Sheet1!Sales' for local names)

package/wrapper.js

@@ -1263,6 +1263,25 @@ class Workbook {
     return this._native.saveToBuffer()
   }
 
+  saveToStream(writable) {
+    const os = require('os')
+    const path = require('path')
+    const fs = require('fs')
+    const crypto = require('crypto')
+
+    const tmpFile = path.join(os.tmpdir(), `rusc-xlsx-${crypto.randomBytes(8).toString('hex')}.xlsx`)
+    this._native.save(tmpFile)
+
+    const readable = fs.createReadStream(tmpFile)
+    readable.on('end', () => {
+      fs.unlink(tmpFile, () => {})
+    })
+    readable.on('error', () => {
+      fs.unlink(tmpFile, () => {})
+    })
+    readable.pipe(writable)
+  }
+
   defineName(name, formula) {
     return this._native.defineName(name, formula)
   }