heapdump - npm Package Compare versions

Comparing version 0.2.9 to 0.2.10

package.json

 {
   "name": "heapdump",
   "main": "./build/Release/heapdump",
-  "version": "0.2.9",
+  "version": "0.2.10",
   "description": "Make a dump of the V8 heap for later inspection.",
@@ -19,3 +19,10 @@ "homepage": "https://github.com/bnoordhuis/node-heapdump",
   },
-  "license": "ISC"
+  "license": "ISC",
+  "scripts": {
+    "test": "tap test/test-*"
+  },
+  "devDependencies": {
+    "shelljs": "~0.3.0",
+    "tap": "~0.4.12"
+  }
 }

README.md

@@ -24,8 +24,15 @@ node-heapdump
 
-The module exports a single `writeSnapshot([filename])` function that writes
-out a snapshot.  `filename` defaults to `heapdump-<sec>.<usec>.heapsnapshot`
-when omitted.
+The module exports a single `writeSnapshot([filename], [callback])` function
+that writes out a snapshot.  `filename` defaults to
+`heapdump-<sec>.<usec>.heapsnapshot` when omitted.
 
     heapdump.writeSnapshot('/var/local/' + Date.now() + '.heapsnapshot');
 
+The function also takes an optional callback function which is called upon
+completion of the heap dump.
+
+    heapdump.writeSnapshot(function() {
+      console.log('dump complete');
+    });
+
 On UNIX, it forks off a new process that writes out the snapshot in an
@@ -32,0 +39,0 @@ asynchronous fashion.  (That is, the function does not block.)

No alert changes

Improved metrics

Total package byte prevSize

20375

41.89%

Number of package files

12

20%

Lines of code

133

432%

Number of lines in readme file

75

10.29%

Worsened metrics

Dev dependency count

2

Infinity%

Number of medium supply chain risk alerts

4

100%

No dependency changes