vm: clarify timeout option in vm

This updates the documentation to clarify how to use `timeout` in the vm module. PR-URL: #23512 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
nodejs · Nov 6, 2018 · 9c15124 · 9c15124
1 parent 8642eac
commit 9c15124
Showing 1 changed file with 14 additions and 14 deletions.
diff --git a/doc/api/vm.md b/doc/api/vm.md
@@ -246,9 +246,9 @@ in the ECMAScript specification.
 ### module.evaluate([options])
 
 * `options` {Object}
-  * `timeout` {number} Specifies the number of milliseconds to evaluate
+  * `timeout` {integer} Specifies the number of milliseconds to evaluate
     before terminating execution. If execution is interrupted, an [`Error`][]
-    will be thrown.
+    will be thrown. This value must be a strictly positive integer.
   * `breakOnSigint` {boolean} If `true`, the execution will be terminated when
     `SIGINT` (Ctrl+C) is received. Existing handlers for the event that have
     been attached via `process.on('SIGINT')` will be disabled during script
@@ -507,9 +507,9 @@ changes:
   * `displayErrors` {boolean} When `true`, if an [`Error`][] error occurs
     while compiling the `code`, the line of code causing the error is attached
     to the stack trace.
-  * `timeout` {number} Specifies the number of milliseconds to execute `code`
+  * `timeout` {integer} Specifies the number of milliseconds to execute `code`
     before terminating execution. If execution is terminated, an [`Error`][]
-    will be thrown.
+    will be thrown. This value must be a strictly positive integer.
   * `breakOnSigint`: if `true`, the execution will be terminated when
     `SIGINT` (Ctrl+C) is received. Existing handlers for the
     event that have been attached via `process.on('SIGINT')` will be disabled
@@ -570,9 +570,9 @@ changes:
   * `displayErrors` {boolean} When `true`, if an [`Error`][] error occurs
     while compiling the `code`, the line of code causing the error is attached
     to the stack trace.
-  * `timeout` {number} Specifies the number of milliseconds to execute `code`
+  * `timeout` {integer} Specifies the number of milliseconds to execute `code`
     before terminating execution. If execution is terminated, an [`Error`][]
-    will be thrown.
+    will be thrown. This value must be a strictly positive integer.
   * `contextName` {string} Human-readable name of the newly created context.
     **Default:** `'VM Context i'`, where `i` is an ascending numerical index of
     the created context.
@@ -628,9 +628,9 @@ added: v0.3.1
   * `displayErrors` {boolean} When `true`, if an [`Error`][] error occurs
     while compiling the `code`, the line of code causing the error is attached
     to the stack trace.
-  * `timeout` {number} Specifies the number of milliseconds to execute `code`
+  * `timeout` {integer} Specifies the number of milliseconds to execute `code`
     before terminating execution. If execution is terminated, an [`Error`][]
-    will be thrown.
+    will be thrown. This value must be a strictly positive integer.
 
 Runs the compiled code contained by the `vm.Script` within the context of the
 current `global` object. Running code does not have access to local scope, but
@@ -776,9 +776,9 @@ Returns `true` if the given `sandbox` object has been [contextified][] using
   * `displayErrors` {boolean} When `true`, if an [`Error`][] error occurs
     while compiling the `code`, the line of code causing the error is attached
     to the stack trace.
-  * `timeout` {number} Specifies the number of milliseconds to execute `code`
+  * `timeout` {integer} Specifies the number of milliseconds to execute `code`
     before terminating execution. If execution is terminated, an [`Error`][]
-    will be thrown.
+    will be thrown. This value must be a strictly positive integer.
 
 The `vm.runInContext()` method compiles `code`, runs it within the context of
 the `contextifiedSandbox`, then returns the result. Running code does not have
@@ -823,9 +823,9 @@ added: v0.3.1
   * `displayErrors` {boolean} When `true`, if an [`Error`][] error occurs
     while compiling the `code`, the line of code causing the error is attached
     to the stack trace.
-  * `timeout` {number} Specifies the number of milliseconds to execute `code`
+  * `timeout` {integer} Specifies the number of milliseconds to execute `code`
     before terminating execution. If execution is terminated, an [`Error`][]
-    will be thrown.
+    will be thrown. This value must be a strictly positive integer.
   * `contextName` {string} Human-readable name of the newly created context.
     **Default:** `'VM Context i'`, where `i` is an ascending numerical index of
     the created context.
@@ -877,9 +877,9 @@ added: v0.3.1
   * `displayErrors` {boolean} When `true`, if an [`Error`][] error occurs
     while compiling the `code`, the line of code causing the error is attached
     to the stack trace.
-  * `timeout` {number} Specifies the number of milliseconds to execute `code`
+  * `timeout` {integer} Specifies the number of milliseconds to execute `code`
     before terminating execution. If execution is terminated, an [`Error`][]
-    will be thrown.
+    will be thrown. This value must be a strictly positive integer.
 
 `vm.runInThisContext()` compiles `code`, runs it within the context of the
 current `global` and returns the result. Running code does not have access to