A super csv file reader/object parser.
| file | String | null | single path to specific file.
| files | [String, Array, Object] | null | cannot be used together with previous option. Accept single and multiple pattern file paths using wildcards, such as:
. This option also allows you to
| the column name which will be parsed into an object structure. Each array position must be related with the file's column index. This header also may be specified on the first line of the file and, if it is what you want, you should not pass this option into the CsvObject constructor.
or [Function] | null | delegate functions to format and transform every or a specific cell value.
Methods | name | required | description | response |
Demos with-header.csv) defines the object structure desired on its own (first line). The second does not have any header, so we gonna have to define it into the configuration header option. > with-header.csv > without-header.csv
$3 > index.js javascriptreader.forEach((objs, index) => {
`> output
bash`
$3 > index.js javascriptconst addCompliment = value => {
${value} is nice!const reader = new CsvObject({
reader.forEach((objs, index) => {
> output
bash` option was added to prevent any caracter problems.format option, which can transform any or an specific value of a cell, in this case adding is nice to every value.file option by files, which means we're no longer need to define a specific filename, but find it or them by pattern(./with-*.csv)
$3 without-header.csv and add every options allowed. To the watch option, we gonna need to add into our project a queue and a done directories and put our file into queue folder.> index.js
`javascriptconst addCompliment = value => {
${value} is cool!const reader = new CsvObject({
reader
);\nTotal of Objects: ${tot});`> output
bashIndex: 0
Total of Objects: 3
`Ok, now this is really funny! First, we have changed our
and our separator. Just because we can... and also because our separator has changed into the file. Second, we have no longer the
header definition into our file (without-header.csv), so we had to do it into our configurations. It is important to know that every header definition into the array is relating its index position with the files columns.We have defined our
format function to transform a specific column (or leaf), no more for everything.The
firstLine: true here is optional, since its default value already is that. But, let's suppose we were reading the with-header.csv and assume the definition of the head into our configurations, not into the file. We probably would not want to read the first line. To that case, we could easily set this option to false.The most significant change is the
files option. In this scenario, we want to watch a directory to catch every file which match with our pattern provided into src option, read and then move to another directory defined on dest option, preventing those files to not be read anymore. The watch option is going to set the timeout to listen for changes into our src path.Finally, the
onStart and onFinish methods will be executed on every reading before starting the iterations (returning the filepath at the time) and at end (return the total of lines read), respectively.
That's it!
License
`MIT License
Copyright (c) 2017 Rodrigo Brabo
Permission is hereby granted, free of charge, to any person obtaining a
The above copyright notice and this permission notice shall be included
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS