Skip to content

Commit 1940a2c

Browse files
avivkellertargos
authored andcommitted
doc: fix typed list formatting
PR-URL: #59019 Refs: nodejs/doc-kit#348 Reviewed-By: Chemi Atlow <chemi@atlow.co.il> Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com> Reviewed-By: Claudio Wunder <cwunder@gnome.org>
1 parent 6cb5e0d commit 1940a2c

39 files changed

+666
-669
lines changed

doc/api/async_context.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ asyncLocalStorage.getStore(); // Returns the same object
303303
added: v24.0.0
304304
-->
305305

306-
* {string}
306+
* Type: {string}
307307

308308
The name of the `AsyncLocalStorage` instance if provided.
309309

doc/api/buffer.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1500,7 +1500,7 @@ console.log(Buffer.isEncoding(''));
15001500
added: v0.11.3
15011501
-->
15021502

1503-
* {integer} **Default:** `8192`
1503+
* Type: {integer} **Default:** `8192`
15041504

15051505
This is the size (in bytes) of pre-allocated internal `Buffer` instances used
15061506
for pooling. This value may be modified.
@@ -1557,7 +1557,7 @@ console.log(buf.toString('utf8'));
15571557

15581558
### `buf.buffer`
15591559

1560-
* {ArrayBuffer} The underlying `ArrayBuffer` object based on which this `Buffer`
1560+
* Type: {ArrayBuffer} The underlying `ArrayBuffer` object based on which this `Buffer`
15611561
object is created.
15621562

15631563
This `ArrayBuffer` is not guaranteed to correspond exactly to the original
@@ -1585,7 +1585,7 @@ console.log(buffer.buffer === arrayBuffer);
15851585

15861586
### `buf.byteOffset`
15871587

1588-
* {integer} The `byteOffset` of the `Buffer`'s underlying `ArrayBuffer` object.
1588+
* Type: {integer} The `byteOffset` of the `Buffer`'s underlying `ArrayBuffer` object.
15891589

15901590
When setting `byteOffset` in `Buffer.from(ArrayBuffer, byteOffset, length)`,
15911591
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.
24262426
added: v0.1.90
24272427
-->
24282428

2429-
* {integer}
2429+
* Type: {integer}
24302430

24312431
Returns the number of bytes in `buf`.
24322432

@@ -5221,7 +5221,7 @@ added:
52215221
- v18.15.0
52225222
-->
52235223

5224-
* input {Buffer | ArrayBuffer | TypedArray} The input to validate.
5224+
* `input` {Buffer | ArrayBuffer | TypedArray} The input to validate.
52255225
* Returns: {boolean}
52265226

52275227
This function returns `true` if `input` contains only valid ASCII-encoded data,
@@ -5237,7 +5237,7 @@ added:
52375237
- v18.14.0
52385238
-->
52395239

5240-
* input {Buffer | ArrayBuffer | TypedArray} The input to validate.
5240+
* `input` {Buffer | ArrayBuffer | TypedArray} The input to validate.
52415241
* Returns: {boolean}
52425242

52435243
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.
52515251
added: v0.5.4
52525252
-->
52535253

5254-
* {integer} **Default:** `50`
5254+
* Type: {integer} **Default:** `50`
52555255

52565256
Returns the maximum number of bytes that will be returned when
52575257
`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
52635263
added: v3.0.0
52645264
-->
52655265

5266-
* {integer} The largest size allowed for a single `Buffer` instance.
5266+
* Type: {integer} The largest size allowed for a single `Buffer` instance.
52675267

52685268
An alias for [`buffer.constants.MAX_LENGTH`][].
52695269

@@ -5273,7 +5273,7 @@ An alias for [`buffer.constants.MAX_LENGTH`][].
52735273
added: v3.0.0
52745274
-->
52755275

5276-
* {integer} The largest length allowed for a single `string` instance.
5276+
* Type: {integer} The largest length allowed for a single `string` instance.
52775277

52785278
An alias for [`buffer.constants.MAX_STRING_LENGTH`][].
52795279

@@ -5387,7 +5387,7 @@ changes:
53875387
2<sup>32</sup> - 1 on 64-bit architectures.
53885388
-->
53895389

5390-
* {integer} The largest size allowed for a single `Buffer` instance.
5390+
* Type: {integer} The largest size allowed for a single `Buffer` instance.
53915391

53925392
On 32-bit architectures, this value currently is 2<sup>30</sup> - 1 (about 1
53935393
GiB).
@@ -5404,7 +5404,7 @@ This value is also available as [`buffer.kMaxLength`][].
54045404
added: v8.2.0
54055405
-->
54065406

5407-
* {integer} The largest length allowed for a single `string` instance.
5407+
* Type: {integer} The largest length allowed for a single `string` instance.
54085408

54095409
Represents the largest `length` that a `string` primitive can have, counted
54105410
in UTF-16 code units.

doc/api/child_process.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1604,7 +1604,7 @@ changes:
16041604
description: The object no longer accidentally exposes native C++ bindings.
16051605
-->
16061606
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.
16081608
16091609
The `subprocess.channel` property is a reference to the child's IPC channel. If
16101610
no IPC channel exists, this property is `undefined`.
@@ -1633,7 +1633,7 @@ running, and lets it finish even while the channel is open.
16331633
added: v0.7.2
16341634
-->
16351635
1636-
* {boolean} Set to `false` after `subprocess.disconnect()` is called.
1636+
* Type: {boolean} Set to `false` after `subprocess.disconnect()` is called.
16371637
16381638
The `subprocess.connected` property indicates whether it is still possible to
16391639
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.
16621662
16631663
### `subprocess.exitCode`
16641664
1665-
* {integer}
1665+
* Type: {integer}
16661666
16671667
The `subprocess.exitCode` property indicates the exit code of the child process.
16681668
If the child process is still running, the field will be `null`.
@@ -1787,7 +1787,7 @@ Calls [`subprocess.kill()`][] with `'SIGTERM'`.
17871787
added: v0.5.10
17881788
-->
17891789
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
17911791
send a signal to the child process.
17921792
17931793
The `subprocess.killed` property indicates whether the child process
@@ -1800,7 +1800,7 @@ does not indicate that the child process has been terminated.
18001800
added: v0.1.90
18011801
-->
18021802
1803-
* {integer|undefined}
1803+
* Type: {integer|undefined}
18041804
18051805
Returns the process identifier (PID) of the child process. If the child process
18061806
fails to spawn due to errors, then the value is `undefined` and `error` is
@@ -2098,21 +2098,21 @@ connection to the child.
20982098
20992099
### `subprocess.signalCode`
21002100
2101-
* {string|null}
2101+
* Type: {string|null}
21022102
21032103
The `subprocess.signalCode` property indicates the signal received by
21042104
the child process if any, else `null`.
21052105
21062106
### `subprocess.spawnargs`
21072107
2108-
* {Array}
2108+
* Type: {Array}
21092109
21102110
The `subprocess.spawnargs` property represents the full list of command-line
21112111
arguments the child process was launched with.
21122112
21132113
### `subprocess.spawnfile`
21142114
2115-
* {string}
2115+
* Type: {string}
21162116
21172117
The `subprocess.spawnfile` property indicates the executable file name of
21182118
the child process that is launched.
@@ -2130,7 +2130,7 @@ in which the child process is launched.
21302130
added: v0.1.90
21312131
-->
21322132
2133-
* {stream.Readable|null|undefined}
2133+
* Type: {stream.Readable|null|undefined}
21342134
21352135
A `Readable Stream` that represents the child process's `stderr`.
21362136
@@ -2149,7 +2149,7 @@ if the child process could not be successfully spawned.
21492149
added: v0.1.90
21502150
-->
21512151
2152-
* {stream.Writable|null|undefined}
2152+
* Type: {stream.Writable|null|undefined}
21532153
21542154
A `Writable Stream` that represents the child process's `stdin`.
21552155
@@ -2171,7 +2171,7 @@ if the child process could not be successfully spawned.
21712171
added: v0.7.10
21722172
-->
21732173
2174-
* {Array}
2174+
* Type: {Array}
21752175
21762176
A sparse array of pipes to the child process, corresponding with positions in
21772177
the [`stdio`][] option passed to [`child_process.spawn()`][] that have been set
@@ -2238,7 +2238,7 @@ not be successfully spawned.
22382238
added: v0.1.90
22392239
-->
22402240

2241-
* {stream.Readable|null|undefined}
2241+
* Type: {stream.Readable|null|undefined}
22422242

22432243
A `Readable Stream` that represents the child process's `stdout`.
22442244

doc/api/cluster.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -450,7 +450,7 @@ if (cluster.isPrimary) {
450450
added: v6.0.0
451451
-->
452452

453-
* {boolean}
453+
* Type: {boolean}
454454

455455
This property is `true` if the worker exited due to `.disconnect()`.
456456
If the worker exited any other way, it is `false`. If the
@@ -477,7 +477,7 @@ worker.kill();
477477
added: v0.8.0
478478
-->
479479

480-
* {integer}
480+
* Type: {integer}
481481

482482
Each new worker is given its own unique id, this id is stored in the
483483
`id`.
@@ -595,7 +595,7 @@ it is [`kill()`][].
595595
added: v0.7.0
596596
-->
597597

598-
* {ChildProcess}
598+
* Type: {ChildProcess}
599599

600600
All workers are created using [`child_process.fork()`][], the returned object
601601
from this function is stored as `.process`. In a worker, the global `process`
@@ -860,7 +860,7 @@ Deprecated alias for [`cluster.isPrimary`][].
860860
added: v16.0.0
861861
-->
862862

863-
* {boolean}
863+
* Type: {boolean}
864864

865865
True if the process is a primary. This is determined
866866
by the `process.env.NODE_UNIQUE_ID`. If `process.env.NODE_UNIQUE_ID` is
@@ -872,7 +872,7 @@ undefined, then `isPrimary` is `true`.
872872
added: v0.6.0
873873
-->
874874

875-
* {boolean}
875+
* Type: {boolean}
876876

877877
True if the process is not a primary (it is the negation of `cluster.isPrimary`).
878878

@@ -919,7 +919,7 @@ changes:
919919
description: The `stdio` option is supported now.
920920
-->
921921

922-
* {Object}
922+
* Type: {Object}
923923
* `execArgv` {string\[]} List of string arguments passed to the Node.js
924924
executable. **Default:** `process.execArgv`.
925925
* `exec` {string} File path to worker file. **Default:** `process.argv[1]`.
@@ -1026,7 +1026,7 @@ This can only be called from the primary process.
10261026
added: v0.7.0
10271027
-->
10281028

1029-
* {Object}
1029+
* Type: {Object}
10301030

10311031
A reference to the current worker object. Not available in the primary process.
10321032

@@ -1060,7 +1060,7 @@ if (cluster.isPrimary) {
10601060
added: v0.7.0
10611061
-->
10621062

1063-
* {Object}
1063+
* Type: {Object}
10641064

10651065
A hash that stores the active worker objects, keyed by `id` field. This makes it
10661066
easy to loop through all the workers. It is only available in the primary

0 commit comments

Comments
 (0)