Skip to content

Commit a8998de

Browse files
committed
Updating README
1 parent f866188 commit a8998de

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,12 @@ BMW,X5,2014,3287,M
9090
* `DELIMITER` - Document - Specifies the different types of delimiters
9191
* `FIELD` - String - Field Delimiter. Default: `','`
9292
* `ARRAY` - String - Array Value Delimiter. Default: `';'`
93+
* `WRAP` - String - The character that field values are wrapped in. Default: `''`
9394
* `EOL` - String - End of Line Delimiter. Default: `'\n'`
9495
* `PARSE_CSV_NUMBERS` - Boolean - (TODO) Should numbers that are found in the CSV be converted to numbers? Default: `false`
9596
* `KEYS` - Array - Specify the keys (as strings) that should be converted. Default: `null`
9697
* If you have a nested object (ie. {info : {name: 'Mike'}}), then set options.KEYS to ['info.name']
97-
* If you want all keys to be converted, then specify ```null``` or don't specify the option to utilize the default.
98+
* If you want all keys to be converted, then specify `null` or don't specify the option to utilize the default.
9899

99100
##### csv2json Example:
100101

@@ -145,10 +146,10 @@ $ npm run coverage
145146

146147
Current Coverage is:
147148
```
148-
Statements : 96.86% ( 154/159 )
149-
Branches : 93.22% ( 110/118 )
149+
Statements : 96.88% ( 155/160 )
150+
Branches : 93.55% ( 116/124 )
150151
Functions : 100% ( 31/31 )
151-
Lines : 97.97% ( 145/148 )
152+
Lines : 97.99% ( 146/149 )
152153
```
153154

154155
## Features
@@ -162,6 +163,7 @@ Lines : 97.97% ( 145/148 )
162163
- Ability to re-generate the JSON documents that were used to generate the CSV (including nested documents)
163164
- Allows for custom field delimiters, end of line delimiters, etc.
164165
- Promisifiable via bluebird's .promisify(<function>) and .promisifyAll(<object>) (as of 1.1.1)
166+
- Wrapped value support for json2csv and csv2json (as of 1.3.0)
165167

166168
## F.A.Q.
167169

0 commit comments

Comments
 (0)