export-to-csv - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

build/export-to-csv.js

@@ -12,4 +12,4 @@ "use strict";
     CsvConfigConsts.DEFAULT_SHOW_TITLE = false;
-    CsvConfigConsts.DEFAULT_TITLE = 'My Report';
-    CsvConfigConsts.DEFAULT_FILENAME = 'mycsv.csv';
+    CsvConfigConsts.DEFAULT_TITLE = 'My Generated Report';
+    CsvConfigConsts.DEFAULT_FILENAME = 'generated';
     CsvConfigConsts.DEFAULT_SHOW_LABELS = false;
@@ -16,0 +16,0 @@ CsvConfigConsts.DEFAULT_USE_BOM = true;

package.json

 {
-  "name": "export-to-csv",
-  "version": "0.1.1",
-  "description": "Easily create CSV data from json collection",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/alexcaza/export-to-csv.git"
-  },
-  "scripts": {
-    "dev": "tsc --watch",
-    "test": "tsc && karma start",
-    "prepublishOnly": "tsc"
-  },
-  "keywords": [
-    "export-to-csv",
-    "export-to-excel",
-    "csv",
-    "excel",
-    "libreoffice",
-    "openoffice",
-    "angular2",
-    "typescript",
-    "react",
-    "ngx",
-    "angular4",
-    "angular5"
-  ],
-  "author": "alexcaza",
-  "email": "[e-mail]",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/alexcaza/export-to-csv/issues"
-  },
-  "main": "./build/index.js",
-  "types": "./build/export-to-csv.d.ts",
-  "homepage": "https://github.com/alexcaza/export-to-csv#readme",
-  "devDependencies": {
-    "@types/jasmine": "^2.5.46",
-    "es6-shim": "^0.35.3",
-    "jasmine-core": "^2.4.1",
-    "karma": "^1.5.0",
-    "karma-chrome-launcher": "^2.0.0",
-    "karma-jasmine": "^1.0.2",
-    "karma-phantomjs-launcher": "^1.0.4",
-    "karma-sourcemap-loader": "^0.3.7",
-    "karma-typescript": "^3.0.8",
-    "typescript": "~2.4.0"
-  }
-}
+    "name": "export-to-csv",
+    "version": "0.1.2",
+    "description": "Easily create CSV data from json collection",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/alexcaza/export-to-csv.git"
+    },
+    "scripts": {
+        "dev": "tsc --watch",
+        "test": "tsc && karma start",
+        "prepublishOnly": "tsc"
+    },
+    "keywords": [
+        "export-to-csv",
+        "export-to-excel",
+        "csv",
+        "excel",
+        "libreoffice",
+        "openoffice",
+        "angular2",
+        "typescript",
+        "react",
+        "ngx",
+        "angular4",
+        "angular5"
+    ],
+    "author": "alexcaza",
+    "email": "[e-mail]",
+    "license": "MIT",
+    "bugs": {
+        "url": "https://github.com/alexcaza/export-to-csv/issues"
+    },
+    "main": "./build/index.js",
+    "types": "./build/export-to-csv.d.ts",
+    "homepage": "https://github.com/alexcaza/export-to-csv#readme",
+    "devDependencies": {
+        "@types/jasmine": "^2.5.46",
+        "es6-shim": "^0.35.3",
+        "jasmine-core": "^2.4.1",
+        "karma": "^1.5.0",
+        "karma-chrome-launcher": "^2.0.0",
+        "karma-jasmine": "^1.0.2",
+        "karma-phantomjs-launcher": "^1.0.4",
+        "karma-sourcemap-loader": "^0.3.7",
+        "karma-typescript": "^3.0.8",
+        "typescript": "~2.4.0"
+    }
+}

README.md

@@ -21,3 +21,3 @@ # export-to-csv | Export to CSV Mini Library
   {
-    name: "Test 1",
+    name: 'Test 1',
     age: 13,
@@ -56,4 +56,6 @@ average: 8.2,
 
-const exportToCsv = new ExportToCsv(options);
+const csvExporter = new ExportToCsv(options);
 
+csvExporter.generateCsv(data);
+
 ```
@@ -67,11 +69,11 @@
 | **fieldSeparator**      | , | Defines the field separator character |
-| **filename**      | 'generated' | Defines the field separator character |
+| **filename**      | 'generated' | Sets the name of the downloaded file. ".csv" will be appended to the value provided. |
 | **quoteStrings**      | "      | If provided, will use this characters to "escape" fields, otherwise will use double quotes as deafult |
 | **decimalseparator** | .      | Defines the decimal separator character (default is .). If set to "locale", it uses the [language sensitive representation of the number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toLocaleString).|
 | **showLabels** | false      | If true, the first row will be the `headers` option or object keys if `useKeysAsHeaders` is present|
-| **showTitle** | false      |   |
+| **showTitle** | false      | Includes the title as the first line in the generated file   |
 | **title** | 'My Generated Report' | This string will be used as the report title |
-| **useBom** | true      | If true, adds a BOM character at the start of the CSV |
+| **useBom** | true      | If true, adds a BOM character at the start of the CSV to improve file compatibility |
 | **useKeysAsHeaders** | false      | If true, this will use the keys of the first object in the collection as the column headers|
-| **headers** | []      | Expects an array of strings, which is supplied, will be used as the column headers|
+| **headers** | []      | Expects an array of strings, which if supplied, will be used as the column headers|
 
@@ -78,0 +80,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

85

increased by2.41%

Worsened metrics

Total package byte prevSize

15081

decreased by-81.23%

Number of package files

7

decreased by-61.11%

Lines of code

289

decreased by-60.84%

No dependency changes