From: Ardis Lu <ardisglu@gmail.com>
Date: Sun, 19 Jan 2025 06:24:33 +0000 (-0800)
Subject: Populate JSDoc descriptions for TransformationFunction
X-Git-Tag: v0.1.0~117
X-Git-Url: https://git.ardis.lu/?a=commitdiff_plain;h=8651f8e3e45cdafb1f1424d34d7d94b13ef4264f;p=csvio

Populate JSDoc descriptions for TransformationFunction
---

diff --git a/src/core.js b/src/core.js
index a86c8ed..d5a9d97 100644
--- a/src/core.js
+++ b/src/core.js
@@ -140,8 +140,8 @@ export function createCSVReadableStream(path) {
 /**
  * A function to process a row or rows of CSV data from `createCSVReadableStream`.
  * @callback TransformationFunction
- * @param {TransformationInput} row
- * @returns {TransformationOutput}
+ * @param {TransformationInput} row A row or rows of input CSV data before transformation.
+ * @returns {TransformationOutput} A row or rows of output CSV data after transformation, or null to skip a row.
  */
 
 /**