Skip to content

Commit e8b5170

Browse files
committed
docs: update README to include RegExp support for excludeKeys
1 parent 9898b0f commit e8b5170

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
@@ -87,7 +87,7 @@ Returns the CSV `string` or rejects with an `Error` if there was an issue.
8787
```
8888
* Note: This may result in CSV output that does not map back exactly to the original JSON.
8989
* `excelBOM` - Boolean - Should a unicode character be prepended to allow Excel to open a UTF-8 encoded file with non-ASCII characters present.
90-
* `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`.
90+
* `excludeKeys` - Array - Specify the `string` keys or `RegExp` patterns that should be excluded from the output. Provided `string` 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` (e.g., providing `'baz'` will exclude `'baz.a'` too).
9191
* Default: `[]`
9292
* Note: When used with `unwindArrays`, arrays present at excluded key paths will not be unwound.
9393
* `expandNestedObjects` - Boolean - Should nested objects be deep-converted to CSV?

0 commit comments

Comments
 (0)