json-csv - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

json-csv.js

@@ -24,4 +24,4 @@ exports.toCSV = function(args, callback) {
         }
-
-        flatString += this.prepValue(val.toString())
+        var quoted = typeof field.quoted !== 'undefined' && field.quoted
+        flatString += this.prepValue(val.toString(), quoted)
       }
@@ -52,4 +52,4 @@ }
 
-exports.prepValue = function(arg) {
-  var quoted = arg.indexOf('"') >= 0 || arg.indexOf(',') >= 0
+exports.prepValue = function(arg, forceQuoted) {
+  var quoted = forceQuoted || arg.indexOf('"') >= 0 || arg.indexOf(',') >= 0
   var result = arg.replace('"','""')
@@ -56,0 +56,0 @@ if (quoted)

package.json

 {
   "name": "json-csv",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Export a richly structured, JSON array to CSV",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/cynaptik/json-csv",

README.md

@@ -6,3 +6,36 @@ json-csv
 
+Usage
+-----
+```
+var csv = require('json-csv')
+csv.toCSV(args, callback)
 
+var callback = function(err,csv) {
+  //csv contains string of converted data in CSV format. 
+}
+```
+
+Arguments: 
+```
+  {
+    //required: array of data
+    data : [],
+
+    //field definitions for CSV export
+    fields : 
+    [
+      {
+        //required: field name for source value
+        name : 'string',
+
+        //required: column label for CSV header
+        label : 'string',
+
+        //optional: filter to tranfsorm value before exporting
+        filter : function(value) { return value; }
+      }
+    ]
+  }
+```
+
 Example
@@ -41,3 +74,4 @@ -------
         name : 'name',
-        label : 'Name'
+        label : 'Name',
+        quoted : true
     },
@@ -61,4 +95,4 @@ {
 Name,Email,Amount
-fred,fred@somewhere,1.02
-jo,jo@somewhere,1.02
+"fred",fred@somewhere,1.02
+"jo",jo@somewhere,1.02
 "jo with a comma,",jo@somewhere,1.02
@@ -65,0 +99,0 @@ "jo with a quote""",jo@somewhere,1.02

samples/simple.js

@@ -29,3 +29,4 @@ var csv = require('../json-csv')
         name : 'name',
-        label : 'Name'
+        label : 'Name',
+        quoted : true
     },
@@ -32,0 +33,0 @@ {

No alert changes

Improved metrics

Total package byte prevSize

9690

increased by10.81%

Lines of code

151

increased by1.34%

Number of lines in readme file

170

increased by25%

No dependency changes