memlab 1.1.34 → 1.1.36

package/README.md

@@ -1,25 +1,25 @@
 # memlab
 
-memlab is an E2E testing and analysis framework for finding JavaScript memory
-leaks and optimization opportunities.
+memlab is an end-to-end testing and analysis framework for identifying
+JavaScript memory leaks and optimization opportunities.
 
 Online Resources:
-* [Meta Engineering Blog Post](https://engineering.fb.com/2022/09/12/open-source/memlab/)
 * [Official Website and Demo](https://facebook.github.io/memlab)
 * [Documentation](https://facebook.github.io/memlab/docs/intro)
+* [Meta Engineering Blog Post](https://engineering.fb.com/2022/09/12/open-source/memlab/)
 
 Features:
- * **Browser memory leak detection** - Write test scenario with puppeteer API,
-   memlab auto diffs JS heap snapshots, filters out memory leaks, and
-   aggregates results.
- * **Object-oriented heap traversing API** - Supports self-defined memory leak
-   detector and programmatically analyzing JS heap snapshots taken from
-   Chromium-based browsers, Node.js, Electron.js, and Hermes
+ * **Browser memory leak detection** - Write test scenarios with the Puppeteer
+   API, and memlab will automatically compare JavaScript heap snapshots, filter
+   out memory leaks, and aggregate the results
+ * **Object-oriented heap traversing API** - Supports the creation of
+   self-defined memory leak detector, and enables programmatic analysis JS heap
+   snapshots taken from Chromium-based browsers, Node.js, Electron.js, and Hermes
  * **Memory CLI toolbox** - Built-in toolbox and APIs for finding memory
-   optimization opportunities (not necessarily memory leaks)
- * **Memory assertions in Node.js** - Enables unit test or running node.js
-   program to take a heap snapshot of its own state, do self memory checking,
-   or write advanced memory assertions
+   optimization opportunities (not necessarily just memory leaks)
+ * **Memory assertions in Node.js** - Enables unit tests or running node.js
+   programs to take a heap snapshot of their own state, perform self memory
+   checking, or write advanced memory assertions
 
 ## CLI Usage
 
@@ -96,13 +96,24 @@ with readable variables, function name, and property names on objects).
 Alternatively, you can debug the leak by loading the heap snapshot taken by memlab (saved in `$(memlab get-default-work-dir)/data/cur`)
 in Chrome DevTool and search for the leaked object ID (`@182929`).
 
-**Self-defined leak detector**: If you want to use a self-defined leak detector, add a `filterLeak` callback
-([doc](https://facebook.github.io/memlab/docs/api/interfaces/core_src.IScenario/#-optional-beforeleakfilter-initleakfiltercallback))
+**View Retainer Trace Interactively**
+
+View memory issues detected by memlab based on a single JavaScript
+heap snapshot taken from Chromium, Hermes, memlab, or any node.js
+or Electron.js program:
+```bash
+memlab view-heap --snapshot <PATH TO .heapsnapshot FILE>
+```
+
+You can optionally specify a specific heap object with the object's id: `--node-id @28173` to pinpoint a specific object.
+
+**Self-defined leak detector**: If you want to use a self-defined leak detector, add a `leakFilter` callback
+([doc](https://facebook.github.io/memlab/docs/api/interfaces/core_src.IScenario/#-optional-leakfilter-leakfiltercallback))
 in the scenario file. `filterLeak` will be called for every unreleased heap
 object (`node`) allocated by the target interaction.
 
 ```javascript
-function filterLeak(node, heap) {
+function leakFilter(node, heap) {
   // ... your leak detector logic
   // return true to mark the node as a memory leak
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "memlab",
-  "version": "1.1.34",
+  "version": "1.1.36",
   "license": "MIT",
   "description": "memlab is a framework that analyzes memory and finds memory leaks in JavaScript applications.",
   "main": "dist/index.js",