OSSForks/node
1
0
Fork 0
mirror of https://github.com/zebrajr/node.git synced 2026-01-15 12:15:26 +00:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

doc: consolidate and clarify breakOnSigInt text

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/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>
This commit is contained in:
Rich Trott
2020-10-24 05:25:24 -07:00
committed by Node.js GitHub Bot
parent 0b45382dff
commit 34810e0141
1 changed files with 35 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
doc/api/vm.md
View File

@@ -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