Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 890b03e

Browse filesBrowse files
Trotttargos
authored andcommitted
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: #35692 Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent 1892532 commit 890b03e
Copy full SHA for 890b03e

File tree

Expand file treeCollapse file tree

1 file changed

+35
-35
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+35
-35
lines changed
Open diff view settings
Collapse file

‎doc/api/vm.md‎

Copy file name to clipboardExpand all lines: doc/api/vm.md
+35-35Lines changed: 35 additions & 35 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -146,11 +146,11 @@ changes:
146146
* `timeout` {integer} Specifies the number of milliseconds to execute `code`
147147
before terminating execution. If execution is terminated, an [`Error`][]
148148
will be thrown. This value must be a strictly positive integer.
149-
* `breakOnSigint` {boolean} If `true`, the execution will be terminated when
150-
`SIGINT` (Ctrl+C) is received. Existing handlers for the
151-
event that have been attached via `process.on('SIGINT')` will be disabled
152-
during script execution, but will continue to work after that. If execution
153-
is terminated, an [`Error`][] will be thrown. **Default:** `false`.
149+
* `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT`
150+
(<kbd>Ctrl</kbd>+<kbd>C</kbd>) is received. Existing handlers for the
151+
event that have been attached via `process.on('SIGINT')` are disabled
152+
during script execution, but continue to work after that. If execution
153+
is terminated, an [`Error`][] is thrown. **Default:** `false`.
154154
* Returns: {any} the result of the very last statement executed in the script.
155155

156156
Runs the compiled code contained by the `vm.Script` object within the given
@@ -208,11 +208,11 @@ changes:
208208
* `timeout` {integer} Specifies the number of milliseconds to execute `code`
209209
before terminating execution. If execution is terminated, an [`Error`][]
210210
will be thrown. This value must be a strictly positive integer.
211-
* `breakOnSigint` {boolean} If `true`, the execution will be terminated when
212-
`SIGINT` (Ctrl+C) is received. Existing handlers for the
213-
event that have been attached via `process.on('SIGINT')` will be disabled
214-
during script execution, but will continue to work after that. If execution
215-
is terminated, an [`Error`][] will be thrown. **Default:** `false`.
211+
* `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT`
212+
(<kbd>Ctrl</kbd>+<kbd>C</kbd>) is received. Existing handlers for the
213+
event that have been attached via `process.on('SIGINT')` are disabled
214+
during script execution, but continue to work after that. If execution
215+
is terminated, an [`Error`][] is thrown. **Default:** `false`.
216216
* `contextName` {string} Human-readable name of the newly created context.
217217
**Default:** `'VM Context i'`, where `i` is an ascending numerical index of
218218
the created context.
@@ -272,11 +272,11 @@ changes:
272272
* `timeout` {integer} Specifies the number of milliseconds to execute `code`
273273
before terminating execution. If execution is terminated, an [`Error`][]
274274
will be thrown. This value must be a strictly positive integer.
275-
* `breakOnSigint` {boolean} If `true`, the execution will be terminated when
276-
`SIGINT` (Ctrl+C) is received. Existing handlers for the
277-
event that have been attached via `process.on('SIGINT')` will be disabled
278-
during script execution, but will continue to work after that. If execution
279-
is terminated, an [`Error`][] will be thrown. **Default:** `false`.
275+
* `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT`
276+
(<kbd>Ctrl</kbd>+<kbd>C</kbd>) is received. Existing handlers for the
277+
event that have been attached via `process.on('SIGINT')` are disabled
278+
during script execution, but continue to work after that. If execution
279+
is terminated, an [`Error`][] is thrown. **Default:** `false`.
280280
* Returns: {any} the result of the very last statement executed in the script.
281281

282282
Runs the compiled code contained by the `vm.Script` within the context of the
@@ -511,11 +511,11 @@ in the ECMAScript specification.
511511
* `timeout` {integer} Specifies the number of milliseconds to evaluate
512512
before terminating execution. If execution is interrupted, an [`Error`][]
513513
will be thrown. This value must be a strictly positive integer.
514-
* `breakOnSigint` {boolean} If `true`, the execution will be terminated when
515-
`SIGINT` (Ctrl+C) is received. Existing handlers for the event that have
516-
been attached via `process.on('SIGINT')` will be disabled during script
517-
execution, but will continue to work after that. If execution is
518-
interrupted, an [`Error`][] will be thrown. **Default:** `false`.
514+
* `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT`
515+
(<kbd>Ctrl</kbd>+<kbd>C</kbd>) is received. Existing handlers for the
516+
event that have been attached via `process.on('SIGINT')` are disabled
517+
during script execution, but continue to work after that. If execution
518+
is interrupted, an [`Error`][] is thrown. **Default:** `false`.
519519
* Returns: {Promise}
520520

521521
Evaluate the module.
@@ -961,11 +961,11 @@ changes:
961961
* `timeout` {integer} Specifies the number of milliseconds to execute `code`
962962
before terminating execution. If execution is terminated, an [`Error`][]
963963
will be thrown. This value must be a strictly positive integer.
964-
* `breakOnSigint` {boolean} If `true`, the execution will be terminated when
965-
`SIGINT` (Ctrl+C) is received. Existing handlers for the
966-
event that have been attached via `process.on('SIGINT')` will be disabled
967-
during script execution, but will continue to work after that. If execution
968-
is terminated, an [`Error`][] will be thrown. **Default:** `false`.
964+
* `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT`
965+
(<kbd>Ctrl</kbd>+<kbd>C</kbd>) is received. Existing handlers for the
966+
event that have been attached via `process.on('SIGINT')` are disabled
967+
during script execution, but continue to work after that. If execution
968+
is terminated, an [`Error`][] is thrown. **Default:** `false`.
969969
* `cachedData` {Buffer|TypedArray|DataView} Provides an optional `Buffer` or
970970
`TypedArray`, or `DataView` with V8's code cache data for the supplied
971971
source. When supplied, the `cachedDataRejected` value will be set to
@@ -1044,11 +1044,11 @@ changes:
10441044
* `timeout` {integer} Specifies the number of milliseconds to execute `code`
10451045
before terminating execution. If execution is terminated, an [`Error`][]
10461046
will be thrown. This value must be a strictly positive integer.
1047-
* `breakOnSigint` {boolean} If `true`, the execution will be terminated when
1048-
`SIGINT` (Ctrl+C) is received. Existing handlers for the
1049-
event that have been attached via `process.on('SIGINT')` will be disabled
1050-
during script execution, but will continue to work after that. If execution
1051-
is terminated, an [`Error`][] will be thrown. **Default:** `false`.
1047+
* `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT`
1048+
(<kbd>Ctrl</kbd>+<kbd>C</kbd>) is received. Existing handlers for the
1049+
event that have been attached via `process.on('SIGINT')` are disabled
1050+
during script execution, but continue to work after that. If execution
1051+
is terminated, an [`Error`][] is thrown. **Default:** `false`.
10521052
* `contextName` {string} Human-readable name of the newly created context.
10531053
**Default:** `'VM Context i'`, where `i` is an ascending numerical index of
10541054
the created context.
@@ -1138,11 +1138,11 @@ changes:
11381138
* `timeout` {integer} Specifies the number of milliseconds to execute `code`
11391139
before terminating execution. If execution is terminated, an [`Error`][]
11401140
will be thrown. This value must be a strictly positive integer.
1141-
* `breakOnSigint` {boolean} If `true`, the execution will be terminated when
1142-
`SIGINT` (Ctrl+C) is received. Existing handlers for the
1143-
event that have been attached via `process.on('SIGINT')` will be disabled
1144-
during script execution, but will continue to work after that. If execution
1145-
is terminated, an [`Error`][] will be thrown. **Default:** `false`.
1141+
* `breakOnSigint` {boolean} If `true`, execution is terminated when `SIGINT`
1142+
(<kbd>Ctrl</kbd>+<kbd>C</kbd>) is received. Existing handlers for the
1143+
event that have been attached via `process.on('SIGINT')` are disabled
1144+
during script execution, but continue to work after that. If execution
1145+
is terminated, an [`Error`][] is thrown. **Default:** `false`.
11461146
* `cachedData` {Buffer|TypedArray|DataView} Provides an optional `Buffer` or
11471147
`TypedArray`, or `DataView` with V8's code cache data for the supplied
11481148
source. When supplied, the `cachedDataRejected` value will be set to

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.