You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 5ddb0a3
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/tool-reference.md
+10Lines changed: 10 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -519,6 +519,7 @@ in the DevTools Elements panel (if any).
519
519
**Parameters:**
520
520
521
521
-**filePath** (string) **(required)**: A path to a .heapsnapshot file to read.
522
+
-**maxNameLength** (integer) _(optional)_: Maximum length of names before truncation. Defaults to 100.
522
523
-**pageIdx** (integer) _(optional)_: The zero-based page index. Defaults to 0.
523
524
-**pageSize** (integer) _(optional)_: The number of contexts to return per page. Defaults to 20.
524
525
-**retainedSize** (string) _(optional)_: Inclusive range for the dead-field score of a context (e.g. "10KB", "1MB-2MB", "-1MB", or "1MB-"). A single value is treated as a minimum.
@@ -557,6 +558,7 @@ in the DevTools Elements panel (if any).
557
558
-**filePath** (string) **(required)**: A path to a .heapsnapshot file to read.
558
559
-**id** (number) **(required)**: The ID for the class, obtained from details.
559
560
-**filterName** (enum: "objectsRetainedByDetachedDomNodes", "objectsRetainedByConsole", "objectsRetainedByEventHandlers", "objectsRetainedByContexts", "sharedNativeContext", "noNativeContext", "attributedToSpecificNativeContext") _(optional)_: An optional filter to apply to the nodes.
561
+
-**maxNameLength** (integer) _(optional)_: Maximum length of names before truncation. Defaults to 100.
560
562
-**objectId** (number) _(optional)_: The object ID (nodeId) of the specific native context to filter by when filterName is attributedToSpecificNativeContext.
561
563
-**pageIdx** (number) _(optional)_: The page index for pagination.
562
564
-**pageSize** (number) _(optional)_: The page size for pagination.
@@ -585,6 +587,7 @@ in the DevTools Elements panel (if any).
585
587
586
588
-**filePath** (string) **(required)**: A path to a .heapsnapshot file to read.
587
589
-**nodeId** (number) **(required)**: The node ID to get the dominator chain for.
590
+
-**maxNameLength** (integer) _(optional)_: Maximum length of names before truncation. Defaults to 100.
588
591
589
592
---
590
593
@@ -595,6 +598,7 @@ in the DevTools Elements panel (if any).
595
598
**Parameters:**
596
599
597
600
-**filePath** (string) **(required)**: A path to a .heapsnapshot file to read.
601
+
-**maxNameLength** (integer) _(optional)_: Maximum length of names before truncation. Defaults to 100.
598
602
-**pageIdx** (number) _(optional)_: The page index for pagination.
599
603
-**pageSize** (number) _(optional)_: The page size for pagination.
600
604
@@ -609,6 +613,7 @@ in the DevTools Elements panel (if any).
609
613
-**filePath** (string) **(required)**: A path to a .heapsnapshot file to read.
610
614
-**nodeId** (number) **(required)**: The node ID to get outgoing edges for.
611
615
-**excludePrimitives** (boolean) _(optional)_: Whether to exclude primitive target nodes. Default is true.
616
+
-**maxNameLength** (integer) _(optional)_: Maximum length of names before truncation. Defaults to 100.
612
617
-**pageIdx** (number) _(optional)_: The page index for pagination.
613
618
-**pageSize** (number) _(optional)_: The page size for pagination.
614
619
-**retainedSize** (string) _(optional)_: Inclusive retained size range (e.g. "1MB-2MB", "-1MB", or "1MB-") for target nodes. A single value is treated as a minimum. Currently, only the lower bound is applied.
@@ -624,6 +629,7 @@ in the DevTools Elements panel (if any).
624
629
625
630
-**filePath** (string) **(required)**: A path to a .heapsnapshot file to read.
626
631
-**nodeId** (number) **(required)**: The node ID to get object details for.
632
+
-**maxNameLength** (integer) _(optional)_: Maximum length of names before truncation. Defaults to 100.
627
633
628
634
---
629
635
@@ -635,6 +641,7 @@ in the DevTools Elements panel (if any).
635
641
636
642
-**filePath** (string) **(required)**: A path to a .heapsnapshot file to read.
637
643
-**nodeId** (number) **(required)**: The node ID to get retainers for.
644
+
-**maxNameLength** (integer) _(optional)_: Maximum length of names before truncation. Defaults to 100.
638
645
-**pageIdx** (number) _(optional)_: The page index for pagination.
639
646
-**pageSize** (number) _(optional)_: The page size for pagination.
640
647
@@ -649,6 +656,7 @@ in the DevTools Elements panel (if any).
649
656
-**filePath** (string) **(required)**: A path to a .heapsnapshot file to read.
650
657
-**nodeId** (number) **(required)**: The node ID to get retaining paths for.
651
658
-**maxDepth** (number) _(optional)_: The maximum depth to search for retaining paths.
659
+
-**maxNameLength** (integer) _(optional)_: Maximum length of names before truncation. Defaults to 100.
652
660
-**maxNodes** (number) _(optional)_: The maximum number of nodes to return.
653
661
-**maxSiblings** (number) _(optional)_: The maximum number of siblings to return.
654
662
@@ -661,6 +669,7 @@ in the DevTools Elements panel (if any).
661
669
**Parameters:**
662
670
663
671
-**filePath** (string) **(required)**: A path to a .heapsnapshot file to read.
672
+
-**maxNameLength** (integer) _(optional)_: Maximum length of names before truncation. Defaults to 100.
664
673
665
674
---
666
675
@@ -673,6 +682,7 @@ in the DevTools Elements panel (if any).
673
682
-**filePath** (string) **(required)**: A path to a .heapsnapshot file to read.
674
683
-**className** (string) _(optional)_: Optional regex or text matching object class name.
675
684
-**isDetached** (boolean) _(optional)_: Whether to filter for detached DOM nodes.
685
+
-**maxNameLength** (integer) _(optional)_: Maximum length of names before truncation. Defaults to 100.
0 commit comments