Skip to content

Commit

Permalink
doc: revise v8.getHeapSnapshot()
Browse files Browse the repository at this point in the history
* move entry above v8.getHeapSpaceStatistics() (where it belongs
  alphabetically and is not out of place logically)
* split lengthy sentence into two sentences

PR-URL: #35849
Reviewed-By: Michael Dawson <midawson@redhat.com>
  • Loading branch information
Trott authored and BethGriggs committed Dec 15, 2020
1 parent 990facb commit b11725e
Showing 1 changed file with 20 additions and 20 deletions.
40 changes: 20 additions & 20 deletions doc/api/v8.md
Expand Up @@ -32,6 +32,26 @@ v8.setFlagsFromString('--allow_natives_syntax');
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()`
<!-- YAML
added: v6.0.0
Expand Down Expand Up @@ -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()`
<!-- YAML
added: v1.0.0
Expand Down

0 comments on commit b11725e

Please sign in to comment.