json-to-table - npm Package Compare versions

Comparing version 2.1.2 to 2.1.3

package.json

 {
   "name": "json-to-table",
-  "version": "2.1.2",
+  "version": "2.1.3",
   "description": "Convert an array of Objects into a table format",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -29,10 +29,21 @@ json-to-table converts an array of Javascript objects into a table format.
 //['name', 'address.zip', 'address.state', 'address.street'],
-//['Bob', 12345, 'Euphoria', ''],
-//['Jon', '', '1234 Main St.', 'Arizona']
+//['Bob',  12345,         'Euphoria',      ''],
+//['Jon',  '',            '1234 Main St.', 'Arizona']
 //]
 ```
 
+##Options
+Some available options to pass in as the second argument are as follows.  
+Look at the tests to see all of these options in action.  
+```
+{
+  defaultValue: put whatever you want here //defaults to an empty string
+  includeCollectionLength: if there is a subarray within the object, it will create a header and include that length //defaults to false
+  excludeSubArrays: if there is a subarray within the object, it will remove it completely from the resulting table. //defaults to false
+  checkKeyBeforePath: this will check for a key that has a '.' in it before assuming the '.' means to look deeper in the object //defaults to false
+}
+```
 ##Notes
-If a particular object did not have the key/value that another one did, the default will be an empty string. 
-You can change the default value by passing that in as the second parameter of the function call. 
+If a particular object did not have a key that another one did, the default will be an empty string. 
+You can change the default value by passing an option in as the second parameter of the function call. 
 If you explicitly pass ```undefined``` in as the second value, your defaults will be undefined.
@@ -56,5 +67,5 @@
 //[
-//['name', 'address.zip', 'address.state', 'address.street'],
-//['Bob', 12345, 'Euphoria', 'MY_DEFAULT_STR!!'],
-//['Jon', 'MY_DEFAULT_STR!!', '1234 Main St.', 'Arizona']
+//['name', 'address.zip',     'address.state', 'address.street'],
+//['Bob',  12345,             'Euphoria',      'MY_DEFAULT_STR!!'],
+//['Jon',  'MY_DEFAULT_STR!!','Arizona',       '1234 Main St.']
 //]
@@ -61,0 +72,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

Total package byte prevSize

18307

increased by4.09%

Number of lines in readme file

86

increased by14.67%

No dependency changes