diff --git a/README.md b/README.md index ce83d4f01e..7873653bc3 100644 --- a/README.md +++ b/README.md @@ -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. + +image + +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: - -image - #### 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.