Commit b07f4a3
doc: consolidate and clarify breakOnSigInt text
PR-URL: #35787
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Daijiro Wachi <daijiro.wachi@gmail.com>
Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent 0c17dbd commit b07f4a3
1 file changed
Lines changed: 35 additions & 35 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -146,11 +146,11 @@ changes: | |||
| 146 | 146 | * `timeout` {integer} Specifies the number of milliseconds to execute `code` | |
| 147 | 147 | before terminating execution. If execution is terminated, an [`Error`][] | |
| 148 | 148 | will be thrown. This value must be a strictly positive integer. | |
| 149 | - * `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT` | ||
| 150 | - (<kbd>Ctrl</kbd>+<kbd>C</kbd>) is received. Existing handlers for the | ||
| 151 | - event that have been attached via `process.on('SIGINT')` are disabled | ||
| 152 | - during script execution, but continue to work after that. If execution | ||
| 153 | - is terminated, an [`Error`][] is thrown. **Default:** `false`. | ||
| 149 | + * `breakOnSigint` {boolean} If `true`, receiving `SIGINT` | ||
| 150 | + (<kbd>Ctrl</kbd>+<kbd>C</kbd>) will terminate execution and throw an | ||
| 151 | + [`Error`][]. Existing handlers for the event that have been attached via | ||
| 152 | + `process.on('SIGINT')` are disabled during script execution, but continue to | ||
| 153 | + work after that. **Default:** `false`. | ||
| 154 | 154 | * Returns: {any} the result of the very last statement executed in the script. | |
| 155 | 155 | ||
| 156 | 156 | Runs the compiled code contained by the `vm.Script` object within the given | |
@@ -208,11 +208,11 @@ changes: | |||
| 208 | 208 | * `timeout` {integer} Specifies the number of milliseconds to execute `code` | |
| 209 | 209 | before terminating execution. If execution is terminated, an [`Error`][] | |
| 210 | 210 | will be thrown. This value must be a strictly positive integer. | |
| 211 | - * `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT` | ||
| 212 | - (<kbd>Ctrl</kbd>+<kbd>C</kbd>) is received. Existing handlers for the | ||
| 213 | - event that have been attached via `process.on('SIGINT')` are disabled | ||
| 214 | - during script execution, but continue to work after that. If execution | ||
| 215 | - is terminated, an [`Error`][] is thrown. **Default:** `false`. | ||
| 211 | + * `breakOnSigint` {boolean} If `true`, receiving `SIGINT` | ||
| 212 | + (<kbd>Ctrl</kbd>+<kbd>C</kbd>) will terminate execution and throw an | ||
| 213 | + [`Error`][]. Existing handlers for the event that have been attached via | ||
| 214 | + `process.on('SIGINT')` are disabled during script execution, but continue to | ||
| 215 | + work after that. **Default:** `false`. | ||
| 216 | 216 | * `contextName` {string} Human-readable name of the newly created context. | |
| 217 | 217 | **Default:** `'VM Context i'`, where `i` is an ascending numerical index of | |
| 218 | 218 | the created context. | |
@@ -272,11 +272,11 @@ changes: | |||
| 272 | 272 | * `timeout` {integer} Specifies the number of milliseconds to execute `code` | |
| 273 | 273 | before terminating execution. If execution is terminated, an [`Error`][] | |
| 274 | 274 | will be thrown. This value must be a strictly positive integer. | |
| 275 | - * `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT` | ||
| 276 | - (<kbd>Ctrl</kbd>+<kbd>C</kbd>) is received. Existing handlers for the | ||
| 277 | - event that have been attached via `process.on('SIGINT')` are disabled | ||
| 278 | - during script execution, but continue to work after that. If execution | ||
| 279 | - is terminated, an [`Error`][] is thrown. **Default:** `false`. | ||
| 275 | + * `breakOnSigint` {boolean} If `true`, receiving `SIGINT` | ||
| 276 | + (<kbd>Ctrl</kbd>+<kbd>C</kbd>) will terminate execution and throw an | ||
| 277 | + [`Error`][]. Existing handlers for the event that have been attached via | ||
| 278 | + `process.on('SIGINT')` are disabled during script execution, but continue to | ||
| 279 | + work after that. **Default:** `false`. | ||
| 280 | 280 | * Returns: {any} the result of the very last statement executed in the script. | |
| 281 | 281 | ||
| 282 | 282 | Runs the compiled code contained by the `vm.Script` within the context of the | |
@@ -511,11 +511,11 @@ in the ECMAScript specification. | |||
| 511 | 511 | * `timeout` {integer} Specifies the number of milliseconds to evaluate | |
| 512 | 512 | before terminating execution. If execution is interrupted, an [`Error`][] | |
| 513 | 513 | will be thrown. This value must be a strictly positive integer. | |
| 514 | - * `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT` | ||
| 515 | - (<kbd>Ctrl</kbd>+<kbd>C</kbd>) is received. Existing handlers for the | ||
| 516 | - event that have been attached via `process.on('SIGINT')` are disabled | ||
| 517 | - during script execution, but continue to work after that. If execution | ||
| 518 | - is interrupted, an [`Error`][] is thrown. **Default:** `false`. | ||
| 514 | + * `breakOnSigint` {boolean} If `true`, receiving `SIGINT` | ||
| 515 | + (<kbd>Ctrl</kbd>+<kbd>C</kbd>) will terminate execution and throw an | ||
| 516 | + [`Error`][]. Existing handlers for the event that have been attached via | ||
| 517 | + `process.on('SIGINT')` are disabled during script execution, but continue to | ||
| 518 | + work after that. **Default:** `false`. | ||
| 519 | 519 | * Returns: {Promise} | |
| 520 | 520 | ||
| 521 | 521 | Evaluate the module. | |
@@ -961,11 +961,11 @@ changes: | |||
| 961 | 961 | * `timeout` {integer} Specifies the number of milliseconds to execute `code` | |
| 962 | 962 | before terminating execution. If execution is terminated, an [`Error`][] | |
| 963 | 963 | will be thrown. This value must be a strictly positive integer. | |
| 964 | - * `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT` | ||
| 965 | - (<kbd>Ctrl</kbd>+<kbd>C</kbd>) is received. Existing handlers for the | ||
| 966 | - event that have been attached via `process.on('SIGINT')` are disabled | ||
| 967 | - during script execution, but continue to work after that. If execution | ||
| 968 | - is terminated, an [`Error`][] is thrown. **Default:** `false`. | ||
| 964 | + * `breakOnSigint` {boolean} If `true`, receiving `SIGINT` | ||
| 965 | + (<kbd>Ctrl</kbd>+<kbd>C</kbd>) will terminate execution and throw an | ||
| 966 | + [`Error`][]. Existing handlers for the event that have been attached via | ||
| 967 | + `process.on('SIGINT')` are disabled during script execution, but continue to | ||
| 968 | + work after that. **Default:** `false`. | ||
| 969 | 969 | * `cachedData` {Buffer|TypedArray|DataView} Provides an optional `Buffer` or | |
| 970 | 970 | `TypedArray`, or `DataView` with V8's code cache data for the supplied | |
| 971 | 971 | source. When supplied, the `cachedDataRejected` value will be set to | |
@@ -1044,11 +1044,11 @@ changes: | |||
| 1044 | 1044 | * `timeout` {integer} Specifies the number of milliseconds to execute `code` | |
| 1045 | 1045 | before terminating execution. If execution is terminated, an [`Error`][] | |
| 1046 | 1046 | will be thrown. This value must be a strictly positive integer. | |
| 1047 | - * `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT` | ||
| 1048 | - (<kbd>Ctrl</kbd>+<kbd>C</kbd>) is received. Existing handlers for the | ||
| 1049 | - event that have been attached via `process.on('SIGINT')` are disabled | ||
| 1050 | - during script execution, but continue to work after that. If execution | ||
| 1051 | - is terminated, an [`Error`][] is thrown. **Default:** `false`. | ||
| 1047 | + * `breakOnSigint` {boolean} If `true`, receiving `SIGINT` | ||
| 1048 | + (<kbd>Ctrl</kbd>+<kbd>C</kbd>) will terminate execution and throw an | ||
| 1049 | + [`Error`][]. Existing handlers for the event that have been attached via | ||
| 1050 | + `process.on('SIGINT')` are disabled during script execution, but continue to | ||
| 1051 | + work after that. **Default:** `false`. | ||
| 1052 | 1052 | * `contextName` {string} Human-readable name of the newly created context. | |
| 1053 | 1053 | **Default:** `'VM Context i'`, where `i` is an ascending numerical index of | |
| 1054 | 1054 | the created context. | |
@@ -1138,11 +1138,11 @@ changes: | |||
| 1138 | 1138 | * `timeout` {integer} Specifies the number of milliseconds to execute `code` | |
| 1139 | 1139 | before terminating execution. If execution is terminated, an [`Error`][] | |
| 1140 | 1140 | will be thrown. This value must be a strictly positive integer. | |
| 1141 | - * `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT` | ||
| 1142 | - (<kbd>Ctrl</kbd>+<kbd>C</kbd>) is received. Existing handlers for the | ||
| 1143 | - event that have been attached via `process.on('SIGINT')` are disabled | ||
| 1144 | - during script execution, but continue to work after that. If execution | ||
| 1145 | - is terminated, an [`Error`][] is thrown. **Default:** `false`. | ||
| 1141 | + * `breakOnSigint` {boolean} If `true`, receiving `SIGINT` | ||
| 1142 | + (<kbd>Ctrl</kbd>+<kbd>C</kbd>) will terminate execution and throw an | ||
| 1143 | + [`Error`][]. Existing handlers for the event that have been attached via | ||
| 1144 | + `process.on('SIGINT')` are disabled during script execution, but continue to | ||
| 1145 | + work after that. **Default:** `false`. | ||
| 1146 | 1146 | * `cachedData` {Buffer|TypedArray|DataView} Provides an optional `Buffer` or | |
| 1147 | 1147 | `TypedArray`, or `DataView` with V8's code cache data for the supplied | |
| 1148 | 1148 | source. When supplied, the `cachedDataRejected` value will be set to | |
0 commit comments