json-2-csv - npm Package Compare versions

Comparing version 3.10.0 to 3.10.1

lib/converter.d.ts

@@ -27,3 +27,6 @@ export interface ISharedOptions {
    */
-  keys?: string[];
+  keys?: (string | {
+    field: string;
+    title?: string;
+  })[];
 
@@ -30,0 +33,0 @@ /**

package.json

@@ -8,3 +8,3 @@ {
     "description": "A JSON to CSV and CSV to JSON converter that natively supports sub-documents and auto-generates the CSV heading.",
-    "version": "3.10.0",
+    "version": "3.10.1",
     "homepage": "https://mrodrig.github.io/json-2-csv",
@@ -11,0 +11,0 @@ "repository": {

README.md

@@ -90,5 +90,5 @@ # json-2-csv
     * Default: These will be auto-detected from your data by default.
-    * Keys can either be specified as a String representing the key path that should be converted, or as an Object with the `key` property specifying the path. When specifying keys as an Object, you can also optionally specify a `title` which will be used for that column in the header. The list specified can contain a combination of Objects and Strings. 
+    * Keys can either be specified as a String representing the key path that should be converted, or as an Object with the `field` property specifying the path. When specifying keys as an Object, you can also optionally specify a `title` which will be used for that column in the header. The list specified can contain a combination of Objects and Strings. 
       * `[ 'key1', 'key2', ... ]`
-      * `[ { key: 'key1', title: 'Key 1' }, { key: 'key2' }, 'key3', ... ]`
+      * `[ { field: 'key1', title: 'Key 1' }, { field: 'key2' }, 'key3', ... ]`
     * Key Paths - If you are converting a nested object (ie. {info : {name: 'Mike'}}), then set this to ['info.name']
@@ -95,0 +95,0 @@ * `prependHeader` - Boolean - Should the auto-generated header be prepended as the first line in the CSV?

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

Total package byte prevSize

64776

increased by0.08%

Lines of code

1192

increased by0.25%

No dependency changes