memlab 1.0.6-alpha → 1.0.7-alpha

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +6 -6
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -12,8 +12,8 @@ Install the CLI
12
12
  npm install -g @memlab
13
13
  ```
14
14
 
15
- To find memory leaks in Google Maps, create a scenario file defining how
16
- we want to interact with the Google Maps, let's name it `test-google-maps.js`:
15
+ To find memory leaks in Google Maps, you can create a scenario file defining how
16
+ to interact with the Google Maps, let's name it `test-google-maps.js`:
17
17
 
18
18
  ```javascript
19
19
  // Visit Google Maps
@@ -34,7 +34,7 @@ async function back(page) {
34
34
  module.exports = {action, back, url};
35
35
  ```
36
36
 
37
- Now run memlab with the scenario file, memlab will interaction with
37
+ Now run memlab with the scenario file, memlab will interact with
38
38
  the web page and show detected memory leaks:
39
39
 
40
40
  ```bash
@@ -52,9 +52,9 @@ Analyze pre-fetched v8/hermes `.heapsnapshot` files:
52
52
  memlab analyze unbound-object --snapshot-dir <DIR_OF_SNAPSHOT_FILES>
53
53
  ```
54
54
 
55
- Use `memlab analyze` to view all memory analyses. For extension, view the [doc site](/tba).
55
+ Use `memlab analyze` to view all built-in memory analyses. For extension, view the [doc site](/tba).
56
56
 
57
- View retain trace of a particular object:
57
+ View retainer trace of a particular object:
58
58
  ```bash
59
59
  memlab report --nodeId <HEAP_OBJECT_ID>
60
60
  ```
@@ -63,7 +63,7 @@ Use `memlab help` to view all CLI commands.
63
63
 
64
64
  ## APIs
65
65
 
66
- Use the `memlab` library to start a E2E run in browser and detect memory leaks.
66
+ Use the `memlab` package to start a E2E run in browser and detect memory leaks:
67
67
 
68
68
  ```javascript
69
69
  const memlab = require('memlab');
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "memlab",
3
- "version": "1.0.6-alpha",
3
+ "version": "1.0.7-alpha",
4
4
  "license": "MIT",
5
5
  "description": "memlab is a framework that analyzes memory and finds memory leaks in JavaScript applications.",
6
6
  "main": "dist/index.js",