From 278086a3870ac5ab7b73d28ec7a33ea863c9209b Mon Sep 17 00:00:00 2001 From: Vladimir de Turckheim Date: Fri, 12 Oct 2018 10:25:25 -0700 Subject: [PATCH] vm: clarify timeout option in vm MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This updates the documentation to clarify how to use `timeout` in the vm module. PR-URL: https://github.com/nodejs/node/pull/23512 Reviewed-By: Michaël Zasso Reviewed-By: James M Snell Reviewed-By: Trivikram Kamat --- doc/api/vm.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/api/vm.md b/doc/api/vm.md index ae4daec7166eb6..1058e16d19dae7 100644 --- 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