csv-to-json - npm Package Compare versions

Comparing version 0.0.4 to 0.1.0

lib/csv.js

@@ -35,3 +35,3 @@ var fs = require('fs');
     },
-    write: function (config, next) {
+    writeJsonToFile: function (config, next) {
         fs.writeFile(config.filename, JSON.stringify(config.json), function(err) {
@@ -38,0 +38,0 @@ if (err) {

package.json

 {
   "name": "csv-to-json",
-  "version": "0.0.4",
+  "version": "0.1.0",
   "description": "parses csv and returns it into json object",
@@ -5,0 +5,0 @@ "main": "csv.js",

README.md

@@ -10,13 +10,29 @@ ##csv-to-json
 
-Usage
-=====
-Parse a csv file like this:
+##Usage
 ```javascript
-var csv = require("./csv.js");
-var json = csv.parse('path/to/file'); // Console reads “Parsed Items: #”
+var csv = require('csv-to-json');
 ```
+###.parse(obj, callback);
+Parses the csv and returns it in JSON format
+Expected parameters of
+```javascript
+var obj = {
+    filename: PATH_TO_FILE
+};
+var callback = function(err, json) {
+    // Do something
+};
+```
 
-Writes the parsed file to a file like this:
+###.writeJsonToFile(obj, callback)
+Writes JSON to file
 ```javascript
-csv.write('path/to/file'); // Console reads “Parsed Items: #”
+var obj = {
+    filename: PATH_TO_FILE,
+    json: JSON_OBJECT
+};
+
+var callback = function(err) {
+    // Do something
+};
 ```
@@ -34,1 +50,4 @@
 ```
+
+###Test
+```npm test```

test/csv-test.js

@@ -32,3 +32,3 @@ var chai = require('chai');
 
-describe('csv write test', function (){
+describe('csv write json test', function (){
     var fs = {
@@ -45,3 +45,3 @@ writeFile: function () {
     it('should be able to write csv', function (done) {
-        csv.write({
+        csv.writeJsonToFile({
             json: sampleJson,
@@ -48,0 +48,0 @@ filename: ''

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

49993

increased by806.33%

Number of package files

17

increased by142.86%

Lines of code

488

increased by360.38%

Number of lines in readme file

52

increased by57.58%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes