doc: document vm timeout option perf impact

addaleax · MylesBorins · commit bc66495061c9 · 2017-07-11T17:43:45.000+01:00
Mention that the `timeout` option has a noticeable performance impact. Fixes: #10453 PR-URL: #12751 Reviewed-By: Alexey Orlenko <eaglexrlnk@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
diff --git a/doc/api/vm.md b/doc/api/vm.md
@@ -116,6 +116,10 @@ console.log(util.inspect(sandbox));
 // { animal: 'cat', count: 12, name: 'kitty' }
 ```
 
+*Note*: Using the `timeout` or `breakOnSigint` options will result in new
+event loops and corresponding threads being started, which have a non-zero
+performance overhead.
+
 ### script.runInNewContext([sandbox][, options])
 <!-- YAML
 added: v0.3.1
