-
Notifications
You must be signed in to change notification settings - Fork 0
How to options
To use options, you need to add a third paramters which is an object with options.
Example :
const parsedFile = await parseFile("myfile.csv", schema, {
debug: true,
});
-
For options, when it's writed
boolean
, in reality, it can be anytrue
value of javascript. Same forfalse
. -
command to run test
Test can be run with options :
npm -s run test -- -n test/callBack_force.test.js callBack_force.test.js
Legend :
-s
is to silent npm--
is used to pass the-n
parameters to thetest.js
file-n
is used to allow only useful logtest/callBack_force.test.js
andcallBack_force.test.js
are here to demonstrate that you can omit thetest/
in the string
- name:
debug
- default:
false
- value: boolean:
true
orfalse
This options show the parsed result of your schema (can be useful sometimes)
This options also allow log from the function (example, a mistake)
Test
npm -s run test test/debug.test.js
- name:
separator
- default:
,
- values: string
.csv
stands for "Comma Separated Values", but if you're a rebel, this options is made for you :)
Test
npm -s run test test/custom_separator.test.js
- name:
parse
- default:
true
- value: boolean:
true
orfalse
This function desactivate the parsing of values: function
, int
, float
, string
With this function all is string
Test
npm -s run test test/stop_parse_value.test.js
- name:
lineCallBack
- default:
null
- value: function (async or not)
It activates the callBack after each line, can be useful if ou want to do a insert in database (for example)
Test
npm -s run test test/line_callBack.test.js
- name:
callBackForce
- default:
false
- value: boolean:
true
orfalse
This options allow you to force taking the result of the callBackLine even if it's undefined
or null
Test
npm -s run test test/callBack_force.test.js
npm -s run test test/callBack_force_2.test.js
- name:
arrayParse
- default:
true
- value: boolean:
true
orfalse
This options allow you to disable the parsing in an array.
Test
npm -s run test test/array_parse.test.js
- name:
overrideFirstLine
- default:
false
- value:
array of string
orfalse
This options allow you to override the first line.
Test
npm -s run test test/override_first_line.test.js
- name:
privateSeparator
- default:
...
- value:
string
This options allow you to change the internal separator of the script. It can be useful if values contain .
in their names
Test
npm -s run test test/private_separator.test.js test/private_separator_2.test.js
- name:
avoidVoidLine
- default:
false
- value:
boolean
This options allow you to not parse void line
Test
npm -s run test test/avoidVoidLine.test.js test/avoidVoidLine2.test.js test/avoidVoidLine3.test.js