Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2020-10-17 14:49:05 +0300
committerRich Trott <rtrott@gmail.com>2020-10-24 15:15:05 +0300
commit6bf213936596250b7531e01c564a15d290eb38eb (patch)
tree2e8e000e015cb82df951684f90781196d59ad27c
parentab62fc1dd8c7f25aef8ae0a59d2de9e0da8d7008 (diff)
doc: improve text for breakOnSigint
* Make the 7 instances of breakOnSigint text blocks consistent. * Use present tense. * Use kbd element for keystrokes. * Minor style edits. PR-URL: https://github.com/nodejs/node/pull/35692 Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
-rw-r--r--doc/api/vm.md70
1 files changed, 35 insertions, 35 deletions
diff --git a/doc/api/vm.md b/doc/api/vm.md
index 437a5e0177d..547ff38af0d 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`, 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 execution, but will continue to work after that. If execution
- is terminated, an [`Error`][] will be thrown. **Default:** `false`.
+ * `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`.
* 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`, 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 execution, but will continue to work after that. If execution
- is terminated, an [`Error`][] will be thrown. **Default:** `false`.
+ * `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`.
* `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`, 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 execution, but will continue to work after that. If execution
- is terminated, an [`Error`][] will be thrown. **Default:** `false`.
+ * `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`.
* 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`, 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
- execution, but will continue to work after that. If execution is
- interrupted, an [`Error`][] will be thrown. **Default:** `false`.
+ * `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`.
* 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`, 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 execution, but will continue to work after that. If execution
- is terminated, an [`Error`][] will be thrown. **Default:** `false`.
+ * `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`.
* `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`, 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 execution, but will continue to work after that. If execution
- is terminated, an [`Error`][] will be thrown. **Default:** `false`.
+ * `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`.
* `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`, 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 execution, but will continue to work after that. If execution
- is terminated, an [`Error`][] will be thrown. **Default:** `false`.
+ * `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`.
* `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