GeezerVison is showing github.com — doc: fix typed list formatting · nodejs/node@1940a2c
File treeExpand file treeCollapse file tree Open diff view settings Expand file treeCollapse file tree Open diff view settings Collapse file Copy file name to clipboardExpand all lines: doc/api/async_context.md +1-1Lines changed: 1 addition & 1 deletion - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -303,7 +303,7 @@ asyncLocalStorage.getStore(); // Returns the same object | 303 | 303 | added: v24.0.0 | 304 | 304 | --> | 305 | 305 |
| 306 | | -* {string} | | 306 | +* Type: {string} | 307 | 307 |
| 308 | 308 | The name of the `AsyncLocalStorage` instance if provided. | 309 | 309 |
| |
Collapse file Copy file name to clipboardExpand all lines: doc/api/buffer.md +11-11Lines changed: 11 additions & 11 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -1500,7 +1500,7 @@ console.log(Buffer.isEncoding('')); | 1500 | 1500 | added: v0.11.3 | 1501 | 1501 | --> | 1502 | 1502 |
| 1503 | | -* {integer} **Default:** `8192` | | 1503 | +* Type: {integer} **Default:** `8192` | 1504 | 1504 |
| 1505 | 1505 | This is the size (in bytes) of pre-allocated internal `Buffer` instances used | 1506 | 1506 | for pooling. This value may be modified. | @@ -1557,7 +1557,7 @@ console.log(buf.toString('utf8')); | 1557 | 1557 |
| 1558 | 1558 | ### `buf.buffer` | 1559 | 1559 |
| 1560 | | -* {ArrayBuffer} The underlying `ArrayBuffer` object based on which this `Buffer` | | 1560 | +* Type: {ArrayBuffer} The underlying `ArrayBuffer` object based on which this `Buffer` | 1561 | 1561 | object is created. | 1562 | 1562 |
| 1563 | 1563 | This `ArrayBuffer` is not guaranteed to correspond exactly to the original | @@ -1585,7 +1585,7 @@ console.log(buffer.buffer === arrayBuffer); | 1585 | 1585 |
| 1586 | 1586 | ### `buf.byteOffset` | 1587 | 1587 |
| 1588 | | -* {integer} The `byteOffset` of the `Buffer`'s underlying `ArrayBuffer` object. | | 1588 | +* Type: {integer} The `byteOffset` of the `Buffer`'s underlying `ArrayBuffer` object. | 1589 | 1589 |
| 1590 | 1590 | When setting `byteOffset` in `Buffer.from(ArrayBuffer, byteOffset, length)`, | 1591 | 1591 | or sometimes when allocating a `Buffer` smaller than `Buffer.poolSize`, the | @@ -2426,7 +2426,7 @@ If `value` is an empty string or empty `Buffer`, `byteOffset` will be returned. | 2426 | 2426 | added: v0.1.90 | 2427 | 2427 | --> | 2428 | 2428 |
| 2429 | | -* {integer} | | 2429 | +* Type: {integer} | 2430 | 2430 |
| 2431 | 2431 | Returns the number of bytes in `buf`. | 2432 | 2432 |
| @@ -5221,7 +5221,7 @@ added: | 5221 | 5221 | - v18.15.0 | 5222 | 5222 | --> | 5223 | 5223 |
| 5224 | | -* input {Buffer | ArrayBuffer | TypedArray} The input to validate. | | 5224 | +* `input` {Buffer | ArrayBuffer | TypedArray} The input to validate. | 5225 | 5225 | * Returns: {boolean} | 5226 | 5226 |
| 5227 | 5227 | This function returns `true` if `input` contains only valid ASCII-encoded data, | @@ -5237,7 +5237,7 @@ added: | 5237 | 5237 | - v18.14.0 | 5238 | 5238 | --> | 5239 | 5239 |
| 5240 | | -* input {Buffer | ArrayBuffer | TypedArray} The input to validate. | | 5240 | +* `input` {Buffer | ArrayBuffer | TypedArray} The input to validate. | 5241 | 5241 | * Returns: {boolean} | 5242 | 5242 |
| 5243 | 5243 | This function returns `true` if `input` contains only valid UTF-8-encoded data, | @@ -5251,7 +5251,7 @@ Throws if the `input` is a detached array buffer. | 5251 | 5251 | added: v0.5.4 | 5252 | 5252 | --> | 5253 | 5253 |
| 5254 | | -* {integer} **Default:** `50` | | 5254 | +* Type: {integer} **Default:** `50` | 5255 | 5255 |
| 5256 | 5256 | Returns the maximum number of bytes that will be returned when | 5257 | 5257 | `buf.inspect()` is called. This can be overridden by user modules. See | @@ -5263,7 +5263,7 @@ Returns the maximum number of bytes that will be returned when | 5263 | 5263 | added: v3.0.0 | 5264 | 5264 | --> | 5265 | 5265 |
| 5266 | | -* {integer} The largest size allowed for a single `Buffer` instance. | | 5266 | +* Type: {integer} The largest size allowed for a single `Buffer` instance. | 5267 | 5267 |
| 5268 | 5268 | An alias for [`buffer.constants.MAX_LENGTH`][]. | 5269 | 5269 |
| @@ -5273,7 +5273,7 @@ An alias for [`buffer.constants.MAX_LENGTH`][]. | 5273 | 5273 | added: v3.0.0 | 5274 | 5274 | --> | 5275 | 5275 |
| 5276 | | -* {integer} The largest length allowed for a single `string` instance. | | 5276 | +* Type: {integer} The largest length allowed for a single `string` instance. | 5277 | 5277 |
| 5278 | 5278 | An alias for [`buffer.constants.MAX_STRING_LENGTH`][]. | 5279 | 5279 |
| @@ -5387,7 +5387,7 @@ changes: | 5387 | 5387 | 2<sup>32</sup> - 1 on 64-bit architectures. | 5388 | 5388 | --> | 5389 | 5389 |
| 5390 | | -* {integer} The largest size allowed for a single `Buffer` instance. | | 5390 | +* Type: {integer} The largest size allowed for a single `Buffer` instance. | 5391 | 5391 |
| 5392 | 5392 | On 32-bit architectures, this value currently is 2<sup>30</sup> - 1 (about 1 | 5393 | 5393 | GiB). | @@ -5404,7 +5404,7 @@ This value is also available as [`buffer.kMaxLength`][]. | 5404 | 5404 | added: v8.2.0 | 5405 | 5405 | --> | 5406 | 5406 |
| 5407 | | -* {integer} The largest length allowed for a single `string` instance. | | 5407 | +* Type: {integer} The largest length allowed for a single `string` instance. | 5408 | 5408 |
| 5409 | 5409 | Represents the largest `length` that a `string` primitive can have, counted | 5410 | 5410 | in UTF-16 code units. | |
Collapse file Copy file name to clipboardExpand all lines: doc/api/child_process.md +12-12Lines changed: 12 additions & 12 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -1604,7 +1604,7 @@ changes: | 1604 | 1604 | description: The object no longer accidentally exposes native C++ bindings. | 1605 | 1605 | --> | 1606 | 1606 |
| 1607 | | -* {Object} A pipe representing the IPC channel to the child process. | | 1607 | +* Type: {Object} A pipe representing the IPC channel to the child process. | 1608 | 1608 |
| 1609 | 1609 | The `subprocess.channel` property is a reference to the child's IPC channel. If | 1610 | 1610 | no IPC channel exists, this property is `undefined`. | @@ -1633,7 +1633,7 @@ running, and lets it finish even while the channel is open. | 1633 | 1633 | added: v0.7.2 | 1634 | 1634 | --> | 1635 | 1635 |
| 1636 | | -* {boolean} Set to `false` after `subprocess.disconnect()` is called. | | 1636 | +* Type: {boolean} Set to `false` after `subprocess.disconnect()` is called. | 1637 | 1637 |
| 1638 | 1638 | The `subprocess.connected` property indicates whether it is still possible to | 1639 | 1639 | send and receive messages from a child process. When `subprocess.connected` is | @@ -1662,7 +1662,7 @@ within the child process to close the IPC channel as well. | 1662 | 1662 |
| 1663 | 1663 | ### `subprocess.exitCode` | 1664 | 1664 |
| 1665 | | -* {integer} | | 1665 | +* Type: {integer} | 1666 | 1666 |
| 1667 | 1667 | The `subprocess.exitCode` property indicates the exit code of the child process. | 1668 | 1668 | If the child process is still running, the field will be `null`. | @@ -1787,7 +1787,7 @@ Calls [`subprocess.kill()`][] with `'SIGTERM'`. | 1787 | 1787 | added: v0.5.10 | 1788 | 1788 | --> | 1789 | 1789 |
| 1790 | | -* {boolean} Set to `true` after `subprocess.kill()` is used to successfully | | 1790 | +* Type: {boolean} Set to `true` after `subprocess.kill()` is used to successfully | 1791 | 1791 | send a signal to the child process. | 1792 | 1792 |
| 1793 | 1793 | The `subprocess.killed` property indicates whether the child process | @@ -1800,7 +1800,7 @@ does not indicate that the child process has been terminated. | 1800 | 1800 | added: v0.1.90 | 1801 | 1801 | --> | 1802 | 1802 |
| 1803 | | -* {integer|undefined} | | 1803 | +* Type: {integer|undefined} | 1804 | 1804 |
| 1805 | 1805 | Returns the process identifier (PID) of the child process. If the child process | 1806 | 1806 | fails to spawn due to errors, then the value is `undefined` and `error` is | @@ -2098,21 +2098,21 @@ connection to the child. | 2098 | 2098 |
| 2099 | 2099 | ### `subprocess.signalCode` | 2100 | 2100 |
| 2101 | | -* {string|null} | | 2101 | +* Type: {string|null} | 2102 | 2102 |
| 2103 | 2103 | The `subprocess.signalCode` property indicates the signal received by | 2104 | 2104 | the child process if any, else `null`. | 2105 | 2105 |
| 2106 | 2106 | ### `subprocess.spawnargs` | 2107 | 2107 |
| 2108 | | -* {Array} | | 2108 | +* Type: {Array} | 2109 | 2109 |
| 2110 | 2110 | The `subprocess.spawnargs` property represents the full list of command-line | 2111 | 2111 | arguments the child process was launched with. | 2112 | 2112 |
| 2113 | 2113 | ### `subprocess.spawnfile` | 2114 | 2114 |
| 2115 | | -* {string} | | 2115 | +* Type: {string} | 2116 | 2116 |
| 2117 | 2117 | The `subprocess.spawnfile` property indicates the executable file name of | 2118 | 2118 | the child process that is launched. | @@ -2130,7 +2130,7 @@ in which the child process is launched. | 2130 | 2130 | added: v0.1.90 | 2131 | 2131 | --> | 2132 | 2132 |
| 2133 | | -* {stream.Readable|null|undefined} | | 2133 | +* Type: {stream.Readable|null|undefined} | 2134 | 2134 |
| 2135 | 2135 | A `Readable Stream` that represents the child process's `stderr`. | 2136 | 2136 |
| @@ -2149,7 +2149,7 @@ if the child process could not be successfully spawned. | 2149 | 2149 | added: v0.1.90 | 2150 | 2150 | --> | 2151 | 2151 |
| 2152 | | -* {stream.Writable|null|undefined} | | 2152 | +* Type: {stream.Writable|null|undefined} | 2153 | 2153 |
| 2154 | 2154 | A `Writable Stream` that represents the child process's `stdin`. | 2155 | 2155 |
| @@ -2171,7 +2171,7 @@ if the child process could not be successfully spawned. | 2171 | 2171 | added: v0.7.10 | 2172 | 2172 | --> | 2173 | 2173 |
| 2174 | | -* {Array} | | 2174 | +* Type: {Array} | 2175 | 2175 |
| 2176 | 2176 | A sparse array of pipes to the child process, corresponding with positions in | 2177 | 2177 | the [`stdio`][] option passed to [`child_process.spawn()`][] that have been set | @@ -2238,7 +2238,7 @@ not be successfully spawned. | 2238 | 2238 | added: v0.1.90 | 2239 | 2239 | --> | 2240 | 2240 |
| 2241 | | -* {stream.Readable|null|undefined} | | 2241 | +* Type: {stream.Readable|null|undefined} | 2242 | 2242 |
| 2243 | 2243 | A `Readable Stream` that represents the child process's `stdout`. | 2244 | 2244 |
| |
Collapse file Copy file name to clipboardExpand all lines: doc/api/cluster.md +8-8Lines changed: 8 additions & 8 deletions - Display the source diff
- Display the rich diff
| Original file line number | Diff line number | Diff line change |
|---|
@@ -450,7 +450,7 @@ if (cluster.isPrimary) { | 450 | 450 | added: v6.0.0 | 451 | 451 | --> | 452 | 452 |
| 453 | | -* {boolean} | | 453 | +* Type: {boolean} | 454 | 454 |
| 455 | 455 | This property is `true` if the worker exited due to `.disconnect()`. | 456 | 456 | If the worker exited any other way, it is `false`. If the | @@ -477,7 +477,7 @@ worker.kill(); | 477 | 477 | added: v0.8.0 | 478 | 478 | --> | 479 | 479 |
| 480 | | -* {integer} | | 480 | +* Type: {integer} | 481 | 481 |
| 482 | 482 | Each new worker is given its own unique id, this id is stored in the | 483 | 483 | `id`. | @@ -595,7 +595,7 @@ it is [`kill()`][]. | 595 | 595 | added: v0.7.0 | 596 | 596 | --> | 597 | 597 |
| 598 | | -* {ChildProcess} | | 598 | +* Type: {ChildProcess} | 599 | 599 |
| 600 | 600 | All workers are created using [`child_process.fork()`][], the returned object | 601 | 601 | from this function is stored as `.process`. In a worker, the global `process` | @@ -860,7 +860,7 @@ Deprecated alias for [`cluster.isPrimary`][]. | 860 | 860 | added: v16.0.0 | 861 | 861 | --> | 862 | 862 |
| 863 | | -* {boolean} | | 863 | +* Type: {boolean} | 864 | 864 |
| 865 | 865 | True if the process is a primary. This is determined | 866 | 866 | by the `process.env.NODE_UNIQUE_ID`. If `process.env.NODE_UNIQUE_ID` is | @@ -872,7 +872,7 @@ undefined, then `isPrimary` is `true`. | 872 | 872 | added: v0.6.0 | 873 | 873 | --> | 874 | 874 |
| 875 | | -* {boolean} | | 875 | +* Type: {boolean} | 876 | 876 |
| 877 | 877 | True if the process is not a primary (it is the negation of `cluster.isPrimary`). | 878 | 878 |
| @@ -919,7 +919,7 @@ changes: | 919 | 919 | description: The `stdio` option is supported now. | 920 | 920 | --> | 921 | 921 |
| 922 | | -* {Object} | | 922 | +* Type: {Object} | 923 | 923 | * `execArgv` {string\[]} List of string arguments passed to the Node.js | 924 | 924 | executable. **Default:** `process.execArgv`. | 925 | 925 | * `exec` {string} File path to worker file. **Default:** `process.argv[1]`. | @@ -1026,7 +1026,7 @@ This can only be called from the primary process. | 1026 | 1026 | added: v0.7.0 | 1027 | 1027 | --> | 1028 | 1028 |
| 1029 | | -* {Object} | | 1029 | +* Type: {Object} | 1030 | 1030 |
| 1031 | 1031 | A reference to the current worker object. Not available in the primary process. | 1032 | 1032 |
| @@ -1060,7 +1060,7 @@ if (cluster.isPrimary) { | 1060 | 1060 | added: v0.7.0 | 1061 | 1061 | --> | 1062 | 1062 |
| 1063 | | -* {Object} | | 1063 | +* Type: {Object} | 1064 | 1064 |
| 1065 | 1065 | A hash that stores the active worker objects, keyed by `id` field. This makes it | 1066 | 1066 | easy to loop through all the workers. It is only available in the primary | |
|