Merge pull request #83 from mrodrig/2.2.0

Upgrading dependencies, adding promisified versions of functions

Author: mrodrig

.travis.yml

@@ -1,10 +1,9 @@
 sudo: false
 language: node_js
 node_js:
-- '0.10'
-- '0.11'
-- '0.12'
-- 'iojs'
-matrix:
-  allow_failures:
-  - node_js: '0.11'
+- '4.8'
+- '5.12'
+- '6.13'
+- '7.10'
+- '8.9'
+- '9.6'

README.md

@@ -26,11 +26,7 @@ var converter = require('json-2-csv');
 
 ### API
 
-#### json2csv Documentation
-
-```javascript
-json2csv(array, callback, options)
-```
+#### json2csv(array, callback, options)
 
 * `array` - An array of JSON documents to be converted to CSV.
 * `callback` - A function of the form `function (err, csv)`; 
@@ -65,11 +61,11 @@ json2csv(array, callback, options)
 
 For examples, please refer to the [json2csv API Documentation (Link)](https://github.com/mrodrig/json-2-csv/wiki/json2csv-Documentation)
 
-#### csv2json Documentation
+#### Promisified Version: json2csvPromisified(array, options).then(...).catch(...);
 
-```javascript
-csv2json(csv, callback, options)
-```
+Available in version `2.2.0`, this functionality makes use of promises from the `bluebird` module.
+
+#### csv2json(csv, callback, options)
 
 * `csv` - A string of CSV
 * `callback` - A function of the form `function (err, array)`; This function will receive any errors and/or the array of JSON documents generated.
@@ -94,6 +90,10 @@ csv2json(csv, callback, options)
 
 For examples, please refer to the [csv2json API Documentation (Link)](https://github.com/mrodrig/json-2-csv/wiki/csv2json-Documentation)
 
+#### Promisified Version: csv2jsonPromisified(csv, options).then(...).catch(...);
+
+Available in version `2.2.0`, this functionality makes use of promises from the `bluebird` module.
+
 ## Tests
 
 ```bash
@@ -130,3 +130,4 @@ Please find the updated list (relocated to the Wiki) here: [Frequently Asked Que
 * Promisifiable via bluebird's .promisify(<function>) and .promisifyAll(<object>) (as of 1.1.1)
 * Wrapped value support for json2csv and csv2json (as of 1.3.0)
 * Support for multiple different schemas (as of 1.4.0)
+* Promisified versions of the functions are now available by default: json2csvPromisified, csv2jsonPromisified (as of 2.2.0)

lib/converter.js

@@ -4,7 +4,8 @@ var json2Csv = require('./json-2-csv'), // Require our json-2-csv code
     csv2Json = require('./csv-2-json'), // Require our csv-2-json code
     constants = require('./constants.json'), // Require in constants
     docPath = require('doc-path'),
-    _ = require('underscore'); // Require underscore
+    promise = require('bluebird'),
+    _ = require('underscore');
 
 /**
  * Default options
@@ -63,7 +64,7 @@ var buildOptions = function (opts, cb) {
 };
 
 // Export the following functions that will be client accessible
-module.exports = {
+var exports = {
 
     /**
      * Client accessible json2csv function
@@ -116,3 +117,11 @@ module.exports = {
         });
     }
 };
+
+// Promisified json2csv:
+exports.json2csvPromisified = promise.promisify(exports.json2csv);
+    
+// Promisified csv2json:
+exports.csv2jsonPromisified = promise.promisify(exports.csv2json);
+
+module.exports = exports;

package.json

@@ -2,7 +2,7 @@
     "author": "mrodrig",
     "name": "json-2-csv",
     "description": "A JSON to CSV and CSV to JSON converter that natively supports sub-documents and auto-generates the CSV heading.",
-    "version": "2.1.2",
+    "version": "2.2.0",
     "repository": {
         "type": "git",
         "url": "http://github.com/mrodrig/json-2-csv.git"
@@ -25,14 +25,14 @@
     ],
     "dependencies": {
         "underscore": "1.8.3",
-        "doc-path": "1.2.0",
+        "doc-path": "1.2.1",
         "bluebird": "3.5.1"
     },
     "devDependencies": {
-        "mocha": "3.3.0",
+        "mocha": "5.0.1",
         "istanbul": "0.4.5",
-        "should": "13.1.2",
-        "async": "2.5.0"
+        "should": "13.2.1",
+        "async": "2.6.0"
     },
     "engines": {
         "node": "*"