heapdump - npm Package Compare versions

Comparing version 0.0.4 to 0.1.0

package.json

 {
   "name": "heapdump",
   "main": "./build/Release/heapdump",
-  "version": "0.0.4",
+  "version": "0.1.0",
   "description": "Make a dump of the V8 heap for later inspection.",
@@ -6,0 +6,0 @@ "homepage": "https://github.com/bnoordhuis/node-heapdump",

README.md

@@ -18,15 +18,30 @@ node-heapdump
 
-    require('heapdump');
+    var heapdump = require('heapdump');
 
-The module does not export any properties. Now send the node process a SIGUSR2
-signal:
+The module exports a single, no-arg function called `writeSnapshot()` that
+writes a `heapdump-xxxx.xxxx.heapsnapshot` file to the application's current
+directory.
 
+    heapdump.writeSnapshot();
+
+On UNIX, it forks off a new process that writes out the snapshot in an
+asynchronous fashion.  (That is, the function does not block.)
+
+On Windows, however, it returns only after the snapshot is fully written.
+If the heap is large, that may take a while.
+
+On UNIX platforms, you can force a snapshot by sending the node.js process
+a SIGUSR2 signal:
+
     $ kill -USR2 <pid>
 
-A heapdump-xxxx.xxxx.heapsnapshot is written to the application's current
-directory.
+### Inspecting the snapshot
 
-Open [Google Chrome](https://www.google.com/intl/en/chrome/browser/) and press
-F12 to open the developer toolbar. Go to the `Profiles` tab, right-click in the
-tab pane and select `Load profile...`. Select the dump file and click `Open`.
-You can now inspect the heap snapshot at your leisure.
+Open [Google Chrome](https://www.google.com/intl/en/chrome/browser/) and
+press F12 to open the developer toolbar.
+
+Go to the `Profiles` tab, right-click in the tab pane and select
+`Load profile...`.
+
+Select the dump file and click `Open`.  You can now inspect the heap snapshot
+at your leisure.

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11637

increased by63.21%

Number of package files

11

increased by37.5%

Number of lines in readme file

47

increased by46.88%

Number of medium supply chain risk alerts

2

decreased by-33.33%

No dependency changes