Skip to content

Commit 14e3d20

Browse files
committed
docs: add info to README about arrayIndexesAsKeys option
1 parent feeec3b commit 14e3d20

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ Returns the CSV `string` or rejects with an `Error` if there was an issue.
5050

5151
* `array` - An array of JSON documents to be converted to CSV.
5252
* `options` - (Optional) A JSON document specifying any of the following key value pairs:
53+
* `arrayIndexesAsKeys` - Boolean - Should array indexes be included in the generated keys?
54+
* Default: `false`
55+
* Note: This provides a more accurate representation of the JSON in the returned CSV, but may be less human readable. See [#207](https://github.com/mrodrig/json-2-csv/issues/207) for more details.
5356
* `checkSchemaDifferences` - Boolean - Should all documents have the same schema?
5457
* Default: `false`
5558
* Note: An error will be thrown if some documents have differing schemas when this is set to `true`.

0 commit comments

Comments
 (0)