From 74c6855a88e1b7bfb31ff7ac086629faba98ee00 Mon Sep 17 00:00:00 2001 From: mhkeller Date: Tue, 19 Sep 2017 22:51:38 -0400 Subject: [PATCH] update docs --- docs/index.html | 190 ++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 153 insertions(+), 37 deletions(-) diff --git a/docs/index.html b/docs/index.html index 07b2cf3..bc638af 100644 --- a/docs/index.html +++ b/docs/index.html @@ -433,6 +433,16 @@ + +
  • + .convertData + + + +
    • +
    @@ -512,7 +522,7 @@

    - + source @@ -732,7 +742,7 @@

    - + source @@ -942,7 +952,7 @@

    - + source @@ -1126,7 +1136,7 @@

    - + source @@ -1321,7 +1331,7 @@

    - + source @@ -1537,7 +1547,7 @@

    - + source @@ -1728,7 +1738,7 @@

    - + source @@ -1844,7 +1854,7 @@

    - + source @@ -1959,7 +1969,7 @@

    - + source @@ -2060,7 +2070,7 @@

    - + source @@ -2154,7 +2164,7 @@

    - + source @@ -2258,7 +2268,7 @@

    - + source @@ -2371,7 +2381,7 @@

    - + source @@ -2479,7 +2489,7 @@

    - + source @@ -2668,7 +2678,7 @@

    - + source @@ -2830,7 +2840,7 @@

    - + source @@ -2934,7 +2944,7 @@

    - + source @@ -3033,7 +3043,7 @@

    - + source @@ -3137,7 +3147,7 @@

    - + source @@ -3235,7 +3245,7 @@

    - + source @@ -3334,7 +3344,7 @@

    - + source @@ -3429,7 +3439,7 @@

    - + source @@ -3584,7 +3594,7 @@

    - + source @@ -3749,14 +3759,14 @@

    - + source
    -

    Reads in a dbf file with .readDbf and write to file using .writeData. A convenience function for converting DBFs to more useable formats. Formerly known as writeDbfToData and is aliased for legacy support.

    +

    Reads in a dbf file with readData and write to file using writeData. A convenience function for converting DBFs to more useable formats. Formerly known as writeDbfToData and is aliased for legacy support.

    @@ -3870,7 +3880,7 @@

    - + source @@ -3987,7 +3997,7 @@

    - + source @@ -4066,7 +4076,7 @@

    - + source @@ -4149,7 +4159,7 @@

    - + source @@ -4241,7 +4251,7 @@

    - + source @@ -4323,7 +4333,7 @@

    - + source @@ -4402,7 +4412,7 @@

    - + source @@ -4546,7 +4556,7 @@

    - + source @@ -4634,7 +4644,7 @@

    - + source @@ -4716,7 +4726,7 @@

    - + source @@ -4786,7 +4796,7 @@

    - + source @@ -4871,7 +4881,7 @@

    - + source @@ -4947,6 +4957,112 @@

    + + + + + +
    + + +
    + +

    + # io.convertData(inFilePath: String, outFilePath: String, options: Object?, callback: Function) +

    + + + + source + + +
    + + +

    Reads in data given a path ending in the file format with readData and writes to file using writeData. A convenience function for converting files to more other formats.

    + + + + + + + + + + + + + + + +
    Parameters
    +
    + +
    +
    + inFilePath (String) + Input file path + +
    + +
    + +
    +
    + outFilePath (String) + Output file path + +
    + +
    + +
    +
    + options (Object?) + Optional config object that's passed to +writeData +. See that documentation for full options, which vary depending on the output format you choose. + +
    + +
    + +
    +
    + callback (Function) + Has signature +(err) + +
    + +
    + +
    + + + + + + + +
    Example
    + + + 
    io.convertData('path/to/data.dbf', 'path/to/data.csv', function (err) {
+  console.log(err)
+})
+
+io.convertData('path/to/data.csv', 'path/to/create/to/data.dbf', {makeDirectories: true}, function (err) {
+  console.log(err)
+})
    + + + + + + + +