From: Ardis Lu <ardisglu@gmail.com>
Date: Mon, 20 Jan 2025 07:44:36 +0000 (-0800)
Subject: Add note about maxConcurrent for transformation function
X-Git-Tag: v0.1.0~103
X-Git-Url: https://git.ardis.lu/?a=commitdiff_plain;h=866a131303bfefa93f7b7a59733b4cdadf7e7a3e;p=csvio

Add note about maxConcurrent for transformation function
---

diff --git a/src/core.js b/src/core.js
index 94c47d8..b2dc40b 100644
--- a/src/core.js
+++ b/src/core.js
@@ -190,6 +190,9 @@ export class CSVTransformer extends TransformStream {
    * if there is only 1 row in the batch (except for the header row). The header row is always processed by itself and passed as a
    * `Array<string>`, regardless of the `options.maxBatchSize` value.
    * 
+   * If `options.maxConcurrent` is a number greater than `1`, multiple instances of the transformation function will be executed
+   * concurrently in groups up to the size of `options.maxConcurrent`.
+   * 
    * Return `null` to consume an input row without emitting an output row.
    * @param {CSVTransformerOptions} options Object containing flags to configure the stream logic.
    */