Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: consolidate and clarify breakOnSigInt text #35787

Closed
wants to merge 1 commit into from
Closed

doc: consolidate and clarify breakOnSigInt text #35787

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
70 changes: 35 additions & 35 deletions doc/api/vm.md
View file
Open in desktop
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down