]> git.ardis.lu - csvio/commitdiff
Populate JSDoc descriptions for TransformationFunction
authorArdis Lu <ardisglu@gmail.com>
Sun, 19 Jan 2025 06:24:33 +0000 (22:24 -0800)
committerArdis Lu <ardisglu@gmail.com>
Sun, 19 Jan 2025 06:24:33 +0000 (22:24 -0800)
src/core.js

index a86c8edbaf4eeb92adcc8ce053ab13891d8764f8..d5a9d97f8fd09c5f8eff138a4a4c7db7379fcfe8 100644 (file)
@@ -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.
  */
 
 /**
This page took 0.037678 seconds and 4 git commands to generate.