summaryrefslogtreecommitdiff
path: root/doc/api/v8.markdown
blob: cedd5c86d9b008e3bd9b630db2ea4b33fbd6f66a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# V8

    Stability: 2 - Stable

This module exposes events and interfaces specific to the version of [V8][]
built with io.js.  These interfaces are subject to change by upstream and are
therefore not covered under the stability index.

## getHeapStatistics()

Returns an object with the following properties

```
{
  total_heap_size: 7326976,
  total_heap_size_executable: 4194304,
  total_physical_size: 7326976,
  used_heap_size: 3476208,
  heap_size_limit: 1535115264
}
```

## setFlagsFromString(string)

Set additional V8 command line flags.  Use 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.

The V8 options available for a version of io.js may be determined by running
`iojs --v8-options`.  An unofficial, community-maintained list of options
and their effects is available
[here](https://github.com/thlorenz/v8-flags/blob/master/flags-0.11.md).

Usage:

```
// Print GC events to stdout for one minute.
var v8 = require('v8');
v8.setFlagsFromString('--trace_gc');
setTimeout(function() { v8.setFlagsFromString('--notrace_gc'); }, 60e3);
```

[V8]: https://code.google.com/p/v8/