Skip to content

Commit ebe2381

Browse files
committed
- Fix typo
1 parent f4c64fe commit ebe2381

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ These might impact performance though.
5353

5454
# Options
5555
* heapdumpOnOOM - boolean whether to create a heapdump when an out of memory occurs. Default true.
56-
* OOMImplementation - Either "NATIVE_HOOK" or "GC_MONITORING". "NATIVE_HOOK" relies on the native v8 hook and makes sure that the heapdump is actually created when the OoM occurs. It's more impacted by the OoMKiller of Unix systems though, when being run in memory resticted environments like Docker.
56+
* OOMImplementation - Either "NATIVE_HOOK" or "GC_MONITORING".
57+
"NATIVE_HOOK" relies on the native v8 hook and makes sure that the heapdump is actually created when the OoM occurs. It's more impacted by the OoMKiller of Unix systems though, when being run in memory restricted environments like Docker.
5758
"GC_MONITORING" is the old implementation, which relies on GC monitoring. It's less impacted by OoMKiller, because the 'threshold' parameter determines when to create the heapdump. Use this option when you run into the OoMKiller of the Unix OS. Default is "NATIVE_HOOK".
5859
* path - the path where the heapdump ends up when an out of memory error occurs. '.heapsnapshot' is automatically appended. Defaults to this modules' directory.
5960
* addTimestamp - add a timestamp to the out of memory heapdump filename, to make it unique. Default is false.

0 commit comments

Comments
 (0)