diff options
| -rw-r--r-- | doc/api/vm.md | 70 |
1 files changed, 35 insertions, 35 deletions
diff --git a/doc/api/vm.md b/doc/api/vm.md index 547ff38af0d..1bd9303fc4e 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` - (<kbd>Ctrl</kbd>+<kbd>C</kbd>) 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` + (<kbd>Ctrl</kbd>+<kbd>C</kbd>) 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` - (<kbd>Ctrl</kbd>+<kbd>C</kbd>) 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` + (<kbd>Ctrl</kbd>+<kbd>C</kbd>) 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` - (<kbd>Ctrl</kbd>+<kbd>C</kbd>) 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` + (<kbd>Ctrl</kbd>+<kbd>C</kbd>) 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` - (<kbd>Ctrl</kbd>+<kbd>C</kbd>) 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` + (<kbd>Ctrl</kbd>+<kbd>C</kbd>) 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. @@ -961,11 +961,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` - (<kbd>Ctrl</kbd>+<kbd>C</kbd>) 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` + (<kbd>Ctrl</kbd>+<kbd>C</kbd>) 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 @@ -1044,11 +1044,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` - (<kbd>Ctrl</kbd>+<kbd>C</kbd>) 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` + (<kbd>Ctrl</kbd>+<kbd>C</kbd>) 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. @@ -1138,11 +1138,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` - (<kbd>Ctrl</kbd>+<kbd>C</kbd>) 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` + (<kbd>Ctrl</kbd>+<kbd>C</kbd>) 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 |