Comparing version 1.0.4 to 1.0.5
{ | ||
"name": "json-csv", | ||
"version": "1.0.4", | ||
"version": "1.0.5", | ||
"description": "Export a richly structured, JSON array to CSV", | ||
@@ -45,3 +45,3 @@ "homepage": "https://github.com/IWSLLC/json-csv", | ||
}, | ||
"license": "BSD" | ||
"license": "BSD-3" | ||
} |
@@ -11,11 +11,13 @@ json-csv | ||
###Buffered### | ||
``` | ||
### Buffered | ||
```js | ||
var jsoncsv = require('json-csv') | ||
jsoncsv.csvBuffered(data, options, callback) | ||
``` | ||
- data : Array of JS objects | ||
- callback : returns buffered result (see below) | ||
``` | ||
```js | ||
var callback = function(err,csv) { | ||
@@ -26,6 +28,6 @@ //csv contains string of converted data in CSV format. | ||
###Streaming### | ||
### Streaming | ||
When using the streaming API, you'll need to also stream data into it. | ||
``` | ||
```js | ||
var jsoncsv = require('json-csv') | ||
@@ -40,22 +42,22 @@ | ||
###Options### | ||
``` | ||
{ | ||
//field definitions for CSV export | ||
fields : | ||
[ | ||
{ | ||
//required: field name for source value | ||
name : 'string', | ||
### Options | ||
```js | ||
{ | ||
//field definitions for CSV export | ||
fields : | ||
[ | ||
{ | ||
//required: field name for source value | ||
name : 'string', | ||
//required: column label for CSV header | ||
label : 'string', | ||
//required: column label for CSV header | ||
label : 'string', | ||
//optional: filter to tranfsorm value before exporting | ||
filter : function(value) { return value; } | ||
} | ||
], | ||
// use a different field separator char | ||
fieldSeparator : ';' | ||
} | ||
//optional: filter to tranfsorm value before exporting | ||
filter : function(value) { return value; } | ||
} | ||
], | ||
// use a different field separator char | ||
fieldSeparator : ';' | ||
} | ||
``` | ||
@@ -67,3 +69,3 @@ | ||
``` | ||
```js | ||
var jsoncsv = require('../json-csv') | ||
@@ -137,3 +139,3 @@ var items = [ | ||
Generates Output: | ||
``` | ||
```csv | ||
Name,Email,Amount | ||
@@ -148,3 +150,3 @@ "fred",fred@somewhere,1.02 | ||
``` | ||
```js | ||
var jsoncsv = require('json-csv') | ||
@@ -209,7 +211,6 @@ var items = [ | ||
}); | ||
``` | ||
Generates Output: | ||
``` | ||
```csv | ||
Company,Name,Email,Year,Level | ||
@@ -221,3 +222,3 @@ "Widgets, LLC",John Doe,john@widgets.somewhere,2013,Unknown | ||
Pipe to File (Using example above): | ||
``` | ||
```js | ||
var fs = require("fs") | ||
@@ -224,0 +225,0 @@ var es = require("event-stream") |
255
19919