From 600cffae3c1955f0e0e0b53149780e9edf249d24 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sat, 24 Oct 2020 05:25:24 -0700 Subject: [PATCH] doc: consolidate and clarify breakOnSigInt text MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR-URL: https://github.com/nodejs/node/pull/35787 Reviewed-By: Antoine du Hamel Reviewed-By: Daijiro Wachi Reviewed-By: Juan José Arboleda Reviewed-By: Franziska Hinkelmann Reviewed-By: James M Snell --- doc/api/vm.md | 70 +++++++++++++++++++++++++-------------------------- 1 file changed, 35 insertions(+), 35 deletions(-) diff --git a/doc/api/vm.md b/doc/api/vm.md index baec4a3b928494..e5dcb7b10dd470 100644 --- a/doc/api/vm.md +++ b/doc/api/vm.md @@ -146,11 +146,11 @@ changes: * `timeout` {integer} Specifies the number of milliseconds to execute `code` before terminating execution. If execution is terminated, an [`Error`][] will be thrown. This value must be a strictly positive integer. - * `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT` - (Ctrl+C) is received. Existing handlers for the - event that have been attached via `process.on('SIGINT')` are disabled - during script execution, but continue to work after that. If execution - is terminated, an [`Error`][] is thrown. **Default:** `false`. + * `breakOnSigint` {boolean} If `true`, receiving `SIGINT` + (Ctrl+C) will terminate execution and throw an + [`Error`][]. Existing handlers for the event that have been attached via + `process.on('SIGINT')` are disabled during script execution, but continue to + work after that. **Default:** `false`. * Returns: {any} the result of the very last statement executed in the script. Runs the compiled code contained by the `vm.Script` object within the given @@ -208,11 +208,11 @@ changes: * `timeout` {integer} Specifies the number of milliseconds to execute `code` before terminating execution. If execution is terminated, an [`Error`][] will be thrown. This value must be a strictly positive integer. - * `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT` - (Ctrl+C) is received. Existing handlers for the - event that have been attached via `process.on('SIGINT')` are disabled - during script execution, but continue to work after that. If execution - is terminated, an [`Error`][] is thrown. **Default:** `false`. + * `breakOnSigint` {boolean} If `true`, receiving `SIGINT` + (Ctrl+C) will terminate execution and throw an + [`Error`][]. Existing handlers for the event that have been attached via + `process.on('SIGINT')` are disabled during script execution, but continue to + work after that. **Default:** `false`. * `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. @@ -272,11 +272,11 @@ changes: * `timeout` {integer} Specifies the number of milliseconds to execute `code` before terminating execution. If execution is terminated, an [`Error`][] will be thrown. This value must be a strictly positive integer. - * `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT` - (Ctrl+C) is received. Existing handlers for the - event that have been attached via `process.on('SIGINT')` are disabled - during script execution, but continue to work after that. If execution - is terminated, an [`Error`][] is thrown. **Default:** `false`. + * `breakOnSigint` {boolean} If `true`, receiving `SIGINT` + (Ctrl+C) will terminate execution and throw an + [`Error`][]. Existing handlers for the event that have been attached via + `process.on('SIGINT')` are disabled during script execution, but continue to + work after that. **Default:** `false`. * Returns: {any} the result of the very last statement executed in the script. Runs the compiled code contained by the `vm.Script` within the context of the @@ -511,11 +511,11 @@ in the ECMAScript specification. * `timeout` {integer} Specifies the number of milliseconds to evaluate before terminating execution. If execution is interrupted, an [`Error`][] will be thrown. This value must be a strictly positive integer. - * `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT` - (Ctrl+C) is received. Existing handlers for the - event that have been attached via `process.on('SIGINT')` are disabled - during script execution, but continue to work after that. If execution - is interrupted, an [`Error`][] is thrown. **Default:** `false`. + * `breakOnSigint` {boolean} If `true`, receiving `SIGINT` + (Ctrl+C) will terminate execution and throw an + [`Error`][]. Existing handlers for the event that have been attached via + `process.on('SIGINT')` are disabled during script execution, but continue to + work after that. **Default:** `false`. * Returns: {Promise} Evaluate the module. @@ -959,11 +959,11 @@ changes: * `timeout` {integer} Specifies the number of milliseconds to execute `code` before terminating execution. If execution is terminated, an [`Error`][] will be thrown. This value must be a strictly positive integer. - * `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT` - (Ctrl+C) is received. Existing handlers for the - event that have been attached via `process.on('SIGINT')` are disabled - during script execution, but continue to work after that. If execution - is terminated, an [`Error`][] is thrown. **Default:** `false`. + * `breakOnSigint` {boolean} If `true`, receiving `SIGINT` + (Ctrl+C) will terminate execution and throw an + [`Error`][]. Existing handlers for the event that have been attached via + `process.on('SIGINT')` are disabled during script execution, but continue to + work after that. **Default:** `false`. * `cachedData` {Buffer|TypedArray|DataView} Provides an optional `Buffer` or `TypedArray`, or `DataView` with V8's code cache data for the supplied source. When supplied, the `cachedDataRejected` value will be set to @@ -1042,11 +1042,11 @@ changes: * `timeout` {integer} Specifies the number of milliseconds to execute `code` before terminating execution. If execution is terminated, an [`Error`][] will be thrown. This value must be a strictly positive integer. - * `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT` - (Ctrl+C) is received. Existing handlers for the - event that have been attached via `process.on('SIGINT')` are disabled - during script execution, but continue to work after that. If execution - is terminated, an [`Error`][] is thrown. **Default:** `false`. + * `breakOnSigint` {boolean} If `true`, receiving `SIGINT` + (Ctrl+C) will terminate execution and throw an + [`Error`][]. Existing handlers for the event that have been attached via + `process.on('SIGINT')` are disabled during script execution, but continue to + work after that. **Default:** `false`. * `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. @@ -1136,11 +1136,11 @@ changes: * `timeout` {integer} Specifies the number of milliseconds to execute `code` before terminating execution. If execution is terminated, an [`Error`][] will be thrown. This value must be a strictly positive integer. - * `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT` - (Ctrl+C) is received. Existing handlers for the - event that have been attached via `process.on('SIGINT')` are disabled - during script execution, but continue to work after that. If execution - is terminated, an [`Error`][] is thrown. **Default:** `false`. + * `breakOnSigint` {boolean} If `true`, receiving `SIGINT` + (Ctrl+C) will terminate execution and throw an + [`Error`][]. Existing handlers for the event that have been attached via + `process.on('SIGINT')` are disabled during script execution, but continue to + work after that. **Default:** `false`. * `cachedData` {Buffer|TypedArray|DataView} Provides an optional `Buffer` or `TypedArray`, or `DataView` with V8's code cache data for the supplied source. When supplied, the `cachedDataRejected` value will be set to