-
Notifications
You must be signed in to change notification settings - Fork 29.7k
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.
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
doc: general improvements to v8.md copy #6829
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,17 +1,29 @@ | ||
# V8 | ||
|
||
Stability: 2 - Stable | ||
The `v8` module exposes APIs that are specific to the version of [V8][] | ||
built into the Node.js binary. It can be accessed using: | ||
|
||
This module exposes events and interfaces specific to the version of [V8][] | ||
built with Node.js. These interfaces are subject to change by upstream and are | ||
therefore not covered under the stability index. | ||
```js | ||
const v8 = require('v8'); | ||
``` | ||
|
||
The APIs are subject to change at any time. | ||
|
||
## v8.getHeapStatistics() | ||
<!-- YAML | ||
added: v1.0.0 | ||
--> | ||
|
||
Returns an object with the following properties | ||
Returns an object with the following properties: | ||
|
||
* `total_heap_size` {number} | ||
* `total_heap_size_executable` {number} | ||
* `total_physical_size` {number} | ||
* `total_available_size` {number} | ||
* `used_heap_size` {number} | ||
* `heap_size_limit` {number} | ||
|
||
For example: | ||
|
||
```js | ||
{ | ||
|
@@ -30,11 +42,19 @@ added: v6.0.0 | |
--> | ||
|
||
Returns statistics about the V8 heap spaces, i.e. the segments which make up | ||
the V8 heap. Order of heap spaces nor availability of a heap space can be | ||
guaranteed as the statistics are provided via the V8 `GetHeapSpaceStatistics` | ||
function. | ||
the V8 heap. Neither the ordering of heap spaces, nor the availability of a | ||
heap space can be guaranteed as the statistics are provided via the V8 | ||
`GetHeapSpaceStatistics` function and may change from one V8 version to the | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should we give a link here? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good idea. |
||
next. | ||
|
||
The value returned is an Array of objects containing the following properties: | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: we usually don't capitalize array in sentences |
||
* `space_name` {string} | ||
* `space_size` {number} | ||
* `space_used_size` {number} | ||
* `space_available_size` {number} | ||
* `physical_space_size` {number} | ||
|
||
Example result: | ||
For example: | ||
|
||
``` | ||
[ | ||
|
@@ -81,9 +101,10 @@ Example result: | |
added: v1.0.0 | ||
--> | ||
|
||
Set additional V8 command line flags. Use with care; changing settings | ||
The `v8.setFlagsFromString() method can be used to programmatically set | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. missing backtick |
||
V8 command line flags. This method should be used with care. Changing settings | ||
after the VM has started may result in unpredictable behavior, including | ||
crashes and data loss. Or it may simply do nothing. | ||
crashes and data loss; or it may simply do nothing. | ||
|
||
The V8 options available for a version of Node.js may be determined by running | ||
`node --v8-options`. An unofficial, community-maintained list of options | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not just the APIs, their behavior as well. The paragraph you replaced captures it better, IMO.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ack
On May 18, 2016 1:59 AM, "Ben Noordhuis" notifications@github.com wrote: