Skip to content

Commit

Permalink
doc: improve text for breakOnSigint
Browse files Browse the repository at this point in the history 
* Make the 7 instances of breakOnSigint text blocks consistent.
* Use present tense.
* Use kbd element for keystrokes.
* Minor style edits.

PR-URL: #35692
Reviewed-By: Luigi Pinca <[email protected]>
  • Loading branch information
@Trott @BethGriggs
Trott authored and BethGriggs committed Dec 15, 2020
1 parent c0d9756 commit 47ba122
Showing 1 changed file with 35 additions and 35 deletions.
70 changes: 35 additions & 35 deletions doc/api/vm.md
View file
Original file line number Diff line number Diff line change
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`, 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
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`, 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.
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`, 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
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`, 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.
Expand Down Expand Up @@ -959,11 +959,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
Expand Down Expand Up @@ -1042,11 +1042,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.
Expand Down Expand Up @@ -1136,11 +1136,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
Expand Down

0 comments on commit 47ba122

Please sign in to comment.