Added Types and Unit tests
This commit is contained in:
20
README.md
20
README.md
@@ -5,10 +5,26 @@ efficient and no dependencies.
|
||||
## Usage
|
||||
Only one method is provided;
|
||||
```js
|
||||
const csv = 'Name,Age,Location\nDom,26,Sydney\nSteve,30,New York';
|
||||
const csv = 'Name,Age,Location\nDom,26,"Sydney, Australia"\nSteve,30,"New York, USA"';
|
||||
parseCSV(csv, function(headers, line, index) {
|
||||
console.log(index, '-', line[headers.indexOf('Name')]);//1 - Dom
|
||||
return true;//Return false to break loop
|
||||
})
|
||||
```
|
||||
To stay efficient we ask for a callback that is fired for every line parsed.
|
||||
To stay efficient we ask for a callback that is fired for every line parsed.
|
||||
|
||||
## Options
|
||||
Options can be provided if necessary;
|
||||
```js
|
||||
parseCSV(csv, (headers,line,index) => true, {
|
||||
skipBlanks: false
|
||||
});
|
||||
```
|
||||
|
||||
Current Options;
|
||||
```
|
||||
skipBlanks - True or False, whether or not to skip blank lines
|
||||
```
|
||||
|
||||
## Testing
|
||||
Tests are written in jest. Run `yarn test`
|
||||
Reference in New Issue
Block a user