Skip to content

Commit 12eb3d9

Browse files
committed
Improved doco for CSV parsing options.
1 parent 06ebe09 commit 12eb3d9

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

src/index.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -423,6 +423,7 @@ export interface IAsyncFileReader {
423423
* Returns a promise that later resolves to a DataFrame.
424424
*
425425
* @param config Optional configuration file for parsing.
426+
* The config object is passed directly to [PapaParse.parse](https://www.papaparse.com/docs#strings), please see [PapaParse docs for additional options](https://www.papaparse.com/docs#config).
426427
*
427428
* @returns Returns a promise of a dataframe loaded from the file.
428429
*
@@ -475,6 +476,7 @@ class AsyncFileReader implements IAsyncFileReader {
475476
* Returns a promise that later resolves to a DataFrame.
476477
*
477478
* @param config Optional configuration file for parsing.
479+
* The config object is passed directly to [PapaParse.parse](https://www.papaparse.com/docs#strings), please see [PapaParse docs for additional options](https://www.papaparse.com/docs#config).
478480
*
479481
* @returns Returns a promise of a dataframe loaded from the file.
480482
*
@@ -529,6 +531,7 @@ export interface ISyncFileReader {
529531
* Deserialize a CSV file to a DataFrame.
530532
*
531533
* @param config Optional configuration file for parsing.
534+
* The config object is passed directly to [PapaParse.parse](https://www.papaparse.com/docs#strings), please see [PapaParse docs for additional options](https://www.papaparse.com/docs#config).
532535
*
533536
* @returns Returns a dataframe that was deserialized from the file.
534537
*
@@ -579,6 +582,7 @@ class SyncFileReader implements ISyncFileReader {
579582
* Deserialize a CSV file to a DataFrame.
580583
*
581584
* @param config Optional configuration file for parsing.
585+
* The config object is passed directly to [PapaParse.parse](https://www.papaparse.com/docs#strings), please see [PapaParse docs for additional options](https://www.papaparse.com/docs#config).
582586
*
583587
* @returns Returns a dataframe that was deserialized from the file.
584588
*

0 commit comments

Comments
 (0)