FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: add document for `profile` and `takeHeapSnapshot` command of `node inspect` by cola119 · Pull Request #43018 · nodejs/node · GitHub

/ node Public

doc: add document for profile and takeHeapSnapshot command of node inspect - #43018

Closed
cola119 wants to merge 1 commit into
nodejs:mainfrom
cola119:add-profile-heap-doc
Closed

doc: add document for profile and takeHeapSnapshot command of node inspect#43018
cola119 wants to merge 1 commit into
nodejs:mainfrom
cola119:add-profile-heap-doc

Conversation

cola119 commented May 9, 2022
edited
Loading

Copy link
Copy Markdown
Member

Currently profile and takeHeapSnapshot command are undocumented in the debugger doc.

profile Start CPU profiling session.
profileEnd Stop current CPU profiling session.
profiles Array of completed CPU profiling sessions.
profiles[n].save(filepath = 'node.cpuprofile')
Save CPU profiling session to disk as JSON.
takeHeapSnapshot(filepath = 'node.heapsnapshot')
Take a heap snapshot and save to disk as JSON.

nodejs-github-bot added debugger Issues and PRs related to the debugger subsystem. doc Issues and PRs related to the documentations. labels May 9, 2022
Trott previously requested changes May 9, 2022

Trott left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

One question about the unwatch addition....

Comment thread doc/api/debugger.md Outdated
cola119 force-pushed the add-profile-heap-doc branch from 6355f90 to d7faf6d Compare May 9, 2022 21:43
cola119 requested a review from Trott May 9, 2022 21:44
Trott dismissed their stale review May 9, 2022 21:52

issue resolved

Trott commented May 9, 2022

Copy link
Copy Markdown
Member

@nodejs/documentation I think this is fine, but it does deviate from our usual docs (using default parameter syntax rather than **Default:**, although this is an unusual case and previous elements in the list already deviate from the standard approach). Since this isn't a programmatic API but an interactive REPL, I think it's fine. What do you think?

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

debugger Issues and PRs related to the debugger subsystem. doc Issues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants


Back | FazBrowse Home | New Git URL