1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: revise v8.getHeapSnapshot()

Browse Source 
* move entry above v8.getHeapSpaceStatistics() (where it belongs
  alphabetically and is not out of place logically)
* split lengthy sentence into two sentences

PR-URL: https://github.com/nodejs/node/pull/35849
Reviewed-By: Michael Dawson <midawson@redhat.com>
This commit is contained in:
Rich Trott 2020-10-28 06:58:45 -07:00
parent 456b4e133c
commit ec400f8056
1 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
doc/api/v8.md
View File

@ -32,6 +32,26 @@ v8.setFlagsFromString('--allow_natives_syntax');
console.log(v8.cachedDataVersionTag()); // 183726201 console.log(v8.cachedDataVersionTag()); // 183726201
``` ```
## `v8.getHeapSnapshot()`
<!-- YAML
added: v11.13.0
-->
* Returns: {stream.Readable} A Readable Stream containing the V8 heap snapshot
Generates a snapshot of the current V8 heap and returns a Readable
Stream that may be used to read the JSON serialized representation.
This JSON stream format is intended to be used with tools such as
Chrome DevTools. The JSON schema is undocumented and specific to the
V8 engine. Therefore, the schema may change from one version of V8 to the next.
```js
// Print heap snapshot to the console
const v8 = require('v8');
const stream = v8.getHeapSnapshot();
stream.pipe(process.stdout);
```
## `v8.getHeapSpaceStatistics()` ## `v8.getHeapSpaceStatistics()`
<!-- YAML <!-- YAML
added: v6.0.0 added: v6.0.0
@ -97,26 +117,6 @@ The value returned is an array of objects containing the following properties:
] ]
``` ```
## `v8.getHeapSnapshot()`
<!-- YAML
added: v11.13.0
-->
* Returns: {stream.Readable} A Readable Stream containing the V8 heap snapshot
Generates a snapshot of the current V8 heap and returns a Readable
Stream that may be used to read the JSON serialized representation.
This JSON stream format is intended to be used with tools such as
Chrome DevTools. The JSON schema is undocumented and specific to the
V8 engine, and may change from one version of V8 to the next.
```js
// Print heap snapshot to the console
const v8 = require('v8');
const stream = v8.getHeapSnapshot();
stream.pipe(process.stdout);
```
## `v8.getHeapStatistics()` ## `v8.getHeapStatistics()`
<!-- YAML <!-- YAML
added: v1.0.0 added: v1.0.0