From: Ardis Lu <ardisglu@gmail.com>
Date: Mon, 27 Jan 2025 07:04:03 +0000 (-0800)
Subject: Note that rows includes the header row
X-Git-Tag: v0.1.0~82
X-Git-Url: https://git.ardis.lu/?a=commitdiff_plain;h=dbcac4cfee149a7b2ba56c33ec30ad4a2c13481c;p=csvio

Note that rows includes the header row
---

diff --git a/src/core.js b/src/core.js
index 00c953b..64f3c69 100644
--- a/src/core.js
+++ b/src/core.js
@@ -378,7 +378,7 @@ export class CSVWriter extends WritableStream {
    * @property {number} elapsed The number of milliseconds that have elapsed between this writer's creation and the output CSV file
    * handle closing, or until now if the writer is still writing. Measured using `performance.now()`.
    * @property {number} rows The estimated number of CSV rows that have been written. If the data passed to the writer is
-   * a string, the string is counted as one CSV row (i.e., raw string data is NOT parsed again).
+   * a string, the string is counted as one CSV row (i.e., raw string data is NOT parsed again). Includes the header row (first row).
    * @property {boolean} done If `true`, the writer is finished writing to the output CSV file and the file handle is closed.
    */