Skip to content

Commit f3189f1

Browse files
committed
docs: add information about excludeKeys matching for #244
1 parent 33f74d1 commit f3189f1

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ Returns the CSV `string` or rejects with an `Error` if there was an issue.
6363
* `emptyFieldValue` - Any - Value that, if specified, will be substituted in for field values that are `undefined`, `null`, or an empty string.
6464
* Default: none
6565
* `excelBOM` - Boolean - Should a unicode character be prepended to allow Excel to open a UTF-8 encoded file with non-ASCII characters present.
66-
* `excludeKeys` - Array - Specify the keys that should be excluded from the output.
66+
* `excludeKeys` - Array - Specify the keys that should be excluded from the output. Provided keys will also be used as a RegExp to help exclude keys under a specified prefix, such as all keys of Objects in an Array when `expandArrayObjects` is `true`.
6767
* Default: `[]`
6868
* Note: When used with `unwindArrays`, arrays present at excluded key paths will not be unwound.
6969
* `expandNestedObjects` - Boolean - Should nested objects be deep-converted to CSV?

0 commit comments

Comments
 (0)