Skip to content

doc,v8: clarify v8.writeHeapSnapshot may return undefined #41365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kyranet wants to merge 1 commit into from
Closed

doc,v8: clarify v8.writeHeapSnapshot may return undefined #41365

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc,v8: clarify v8.writeHeapSnapshot may return undefined
  • Loading branch information
@kyranet
kyranet committed Dec 31, 2021
commit 2bdbaf6c1d27cf23bccb6a62b5b736e3ed13e381
3 changes: 2 additions & 1 deletion doc/api/v8.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,8 @@ added: v11.13.0
generated, where `{pid}` will be the PID of the Node.js process,
`{thread_id}` will be `0` when `writeHeapSnapshot()` is called from
the main Node.js thread or the id of a worker thread.
* Returns: {string} The filename where the snapshot was saved.
* Returns: {string|undefined} The filename where the snapshot was saved, or
`undefined` if the file failed to write.
Copy link
Member

@RaisinTen RaisinTen Dec 31, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
`undefined` if the file failed to write.
`undefined` if the process failed to write the file.


Generates a snapshot of the current V8 heap and writes it to a JSON
file. This file is intended to be used with tools such as Chrome
Expand Down