mirrors/bun.sh
1
0
Fork 0
mirror of https://github.com/oven-sh/bun synced 2026-02-09 10:28:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Jarred Sumner
2022-11-28 19:14:45 -08:00
parent 2a33bd2cc5
commit 4efce63dad
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -4788,7 +4788,11 @@ Bun.gc(synchronously);
#### JavaScript heap snapshot
You can also take a heap snapshot of the JavaScript heap. This is useful for debugging memory leaks.
Heap snapshots let you inspect what objects are not being freed. You can use the `bun:jsc` module to take a heap snapshot and then view it with Safari or WebKit GTK developer tools.
<img width="1324" alt="image" src="https://user-images.githubusercontent.com/709451/204429337-b0d8935f-3509-4071-b991-217794d1fb27.png">
To generate a heap snapshot:
```ts
import { generateHeapSnapshot } from "bun:jsc";
@@ -4806,10 +4810,6 @@ To view the snapshot, open the `heap.json` file in Safari's Developer Tools (or
![image](https://user-images.githubusercontent.com/709451/204428943-ba999e8f-8984-4f23-97cb-b4e3e280363e.png)
On success, it will look something like this:
<img width="1324" alt="image" src="https://user-images.githubusercontent.com/709451/204429337-b0d8935f-3509-4071-b991-217794d1fb27.png">
#### Native heap stats
Bun uses mimalloc for the other heap. To report a summary of non-JavaScript memory usage, set the `MIMALLOC_SHOW_STATS=1` environment variable.