fluentreports - npm Package Compare versions

Comparing version 1.0.9 to 1.1.0

changelog.txt

@@ -22,2 +22,3 @@ 0.0.1 - [2013/08/15] - Initial Release
 1.0.9 - Added rotate ability to print() text routine, exposed opacity in print routine
+1.1.0 - Added Ability to use .recordCount & cancel report and fixed issue where Header wasn't printing on no data.
 
@@ -24,0 +25,0 @@

commands.md

@@ -93,2 +93,21 @@ # fluentReports Commands
 
+
+#### .recordCount(recordCountCallback(count, continueCallback))
+##### Description
+This allows you to be notified of the query result count before the printing actually happens.  This is useful where you can't know the report data count before the report starts, because you are passing in a object that does all the queries itself.  The report when it queries the data count, will call your *RecordCountCallback* function, this function will receive a record count, and a callback function.  You MUST call the continueCallback function.  You can optionally pass the continueCallback a boolean "false" to actually cancel the report, any other value (and no value) is considered that you want to continue printing.
+In the event you choose to cancel the report no report will be is generated; and the final render callback done will be passed "false" instead of a filename or buffer.
+##### Parameters
+* recordCountCallback function
+
+##### Example:
+
+function rcCount(count, continueCallback) {
+  if (count === 0) { console.log("No records");  callback(false); }
+  else if (count > 250) { console.log("Too many records") callback(false); }
+  else callback( /* you can pass in true if you want */);
+}
+MyReportObject.recordCount(rcCount);
+
+<br><br><br>
+
 #### .keys ( keys )
@@ -236,4 +255,5 @@ ##### Description
   * if rendering to pipe (err, pipe)
+  * If rendering is CANCELLED (i.e. like via the .recordCount callback) it will return (err, false);
 ##### Example
-MyReportObject.render(function(Err, name) {  console.log("The report was saved to", name);  });
+MyReportObject.render(function(Err, name) {  if (name === false) { console.log("Report was cancelled"); } else { console.log("The report was saved to", name);  });
 
@@ -240,0 +260,0 @@ <br><br><br>

package.json

@@ -32,3 +32,3 @@ {
   "main": "lib/fluentReports",
-  "version": "1.0.9",
+  "version": "1.1.0",
   "engines": {
@@ -35,0 +35,0 @@ "node": ">= 0.6.0"

Fixed alerts

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Improved metrics

Number of low supply chain risk alerts

2

decreased by-50%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

594207

decreased by-21.3%

Number of package files

24

decreased by-42.86%

Lines of code

6406

decreased by-10.14%

No dependency changes