docs(csv): clarify parse document (#5597)

This commit is contained in:
Yoshiya Hinosawa 2024-08-01 14:36:23 +09:00 committed by GitHub
parent 6e1724ba22
commit 577fd9a6e8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -306,8 +306,7 @@ export interface ParseOptions {
}
/**
* Csv parse helper to manipulate data.
* Provides an auto/custom mapper for columns.
* Parses CSV string into an array of arrays of strings.
*
* @example Usage
* ```ts
@ -324,8 +323,10 @@ export interface ParseOptions {
*/
export function parse(input: string): string[][];
/**
* Csv parse helper to manipulate data.
* Provides an auto/custom mapper for columns.
* Parses CSV string into an array of objects or an array of arrays of strings.
*
* If `column` or `skipFirstRow` option is provided, it returns an array of
* objects, otherwise it returns an array of arrays of string.
*
* @example Usage
* ```ts