Skip to content

Commit

Permalink
docs: update README to include RegExp support for excludeKeys
Browse files Browse the repository at this point in the history
  • Loading branch information
mrodrig committed Mar 1, 2024
1 parent 9898b0f commit e8b5170
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Returns the CSV `string` or rejects with an `Error` if there was an issue.
```
* Note: This may result in CSV output that does not map back exactly to the original JSON.
* `excelBOM` - Boolean - Should a unicode character be prepended to allow Excel to open a UTF-8 encoded file with non-ASCII characters present.
* `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`.
* `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).
* Default: `[]`
* Note: When used with `unwindArrays`, arrays present at excluded key paths will not be unwound.
* `expandNestedObjects` - Boolean - Should nested objects be deep-converted to CSV?
Expand Down

0 comments on commit e8b5170

Please sign in to comment.