FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: fix typed list formatting · nodejs/node@1b6b5e7 · GitHub

/ node Public

Commit 1b6b5e7

Browse files
avivkeller
authored and
aduh95
committed
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 756c7dd commit 1b6b5e7

37 files changed

Lines changed: 527 additions & 530 deletions

‎doc/api/buffer.md‎

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

1502-
* {integer} **Default:** `8192`
1502+
* Type: {integer} **Default:** `8192`
15031503

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

15571557
### `buf.buffer`
15581558

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

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

15851585
### `buf.byteOffset`
15861586

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

15891589
When setting `byteOffset` in `Buffer.from(ArrayBuffer, byteOffset, length)`,
15901590
or sometimes when allocating a `Buffer` smaller than `Buffer.poolSize`, the
@@ -2425,7 +2425,7 @@ If `value` is an empty string or empty `Buffer`, `byteOffset` will be returned.
24252425
added: v0.1.90
24262426
-->
24272427

2428-
* {integer}
2428+
* Type: {integer}
24292429

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

@@ -5217,7 +5217,7 @@ added:
52175217
- v18.15.0
52185218
-->
52195219

5220-
* input {Buffer | ArrayBuffer | TypedArray} The input to validate.
5220+
* `input` {Buffer | ArrayBuffer | TypedArray} The input to validate.
52215221
* Returns: {boolean}
52225222

52235223
This function returns `true` if `input` contains only valid ASCII-encoded data,
@@ -5233,7 +5233,7 @@ added:
52335233
- v18.14.0
52345234
-->
52355235

5236-
* input {Buffer | ArrayBuffer | TypedArray} The input to validate.
5236+
* `input` {Buffer | ArrayBuffer | TypedArray} The input to validate.
52375237
* Returns: {boolean}
52385238

52395239
This function returns `true` if `input` contains only valid UTF-8-encoded data,
@@ -5247,7 +5247,7 @@ Throws if the `input` is a detached array buffer.
52475247
added: v0.5.4
52485248
-->
52495249

5250-
* {integer} **Default:** `50`
5250+
* Type: {integer} **Default:** `50`
52515251

52525252
Returns the maximum number of bytes that will be returned when
52535253
`buf.inspect()` is called. This can be overridden by user modules. See
@@ -5259,7 +5259,7 @@ Returns the maximum number of bytes that will be returned when
52595259
added: v3.0.0
52605260
-->
52615261

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

52645264
An alias for [`buffer.constants.MAX_LENGTH`][].
52655265

@@ -5269,7 +5269,7 @@ An alias for [`buffer.constants.MAX_LENGTH`][].
52695269
added: v3.0.0
52705270
-->
52715271

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

52745274
An alias for [`buffer.constants.MAX_STRING_LENGTH`][].
52755275

@@ -5383,7 +5383,7 @@ changes:
53835383
2<sup>32</sup> - 1 on 64-bit architectures.
53845384
-->
53855385

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

53885388
On 32-bit architectures, this value currently is 2<sup>30</sup> - 1 (about 1
53895389
GiB).
@@ -5400,7 +5400,7 @@ This value is also available as [`buffer.kMaxLength`][].
54005400
added: v8.2.0
54015401
-->
54025402

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

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

‎doc/api/child_process.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1602,7 +1602,7 @@ changes:
16021602
description: The object no longer accidentally exposes native C++ bindings.
16031603
-->
16041604
1605-
* {Object} A pipe representing the IPC channel to the child process.
1605+
* Type: {Object} A pipe representing the IPC channel to the child process.
16061606
16071607
The `subprocess.channel` property is a reference to the child's IPC channel. If
16081608
no IPC channel exists, this property is `undefined`.
@@ -1631,7 +1631,7 @@ running, and lets it finish even while the channel is open.
16311631
added: v0.7.2
16321632
-->
16331633
1634-
* {boolean} Set to `false` after `subprocess.disconnect()` is called.
1634+
* Type: {boolean} Set to `false` after `subprocess.disconnect()` is called.
16351635
16361636
The `subprocess.connected` property indicates whether it is still possible to
16371637
send and receive messages from a child process. When `subprocess.connected` is
@@ -1660,7 +1660,7 @@ within the child process to close the IPC channel as well.
16601660
16611661
### `subprocess.exitCode`
16621662
1663-
* {integer}
1663+
* Type: {integer}
16641664
16651665
The `subprocess.exitCode` property indicates the exit code of the child process.
16661666
If the child process is still running, the field will be `null`.
@@ -1783,7 +1783,7 @@ Calls [`subprocess.kill()`][] with `'SIGTERM'`.
17831783
added: v0.5.10
17841784
-->
17851785
1786-
* {boolean} Set to `true` after `subprocess.kill()` is used to successfully
1786+
* Type: {boolean} Set to `true` after `subprocess.kill()` is used to successfully
17871787
send a signal to the child process.
17881788
17891789
The `subprocess.killed` property indicates whether the child process
@@ -1796,7 +1796,7 @@ does not indicate that the child process has been terminated.
17961796
added: v0.1.90
17971797
-->
17981798
1799-
* {integer|undefined}
1799+
* Type: {integer|undefined}
18001800
18011801
Returns the process identifier (PID) of the child process. If the child process
18021802
fails to spawn due to errors, then the value is `undefined` and `error` is
@@ -2094,21 +2094,21 @@ connection to the child.
20942094
20952095
### `subprocess.signalCode`
20962096
2097-
* {string|null}
2097+
* Type: {string|null}
20982098
20992099
The `subprocess.signalCode` property indicates the signal received by
21002100
the child process if any, else `null`.
21012101
21022102
### `subprocess.spawnargs`
21032103
2104-
* {Array}
2104+
* Type: {Array}
21052105
21062106
The `subprocess.spawnargs` property represents the full list of command-line
21072107
arguments the child process was launched with.
21082108
21092109
### `subprocess.spawnfile`
21102110
2111-
* {string}
2111+
* Type: {string}
21122112
21132113
The `subprocess.spawnfile` property indicates the executable file name of
21142114
the child process that is launched.
@@ -2126,7 +2126,7 @@ in which the child process is launched.
21262126
added: v0.1.90
21272127
-->
21282128
2129-
* {stream.Readable|null|undefined}
2129+
* Type: {stream.Readable|null|undefined}
21302130
21312131
A `Readable Stream` that represents the child process's `stderr`.
21322132
@@ -2145,7 +2145,7 @@ if the child process could not be successfully spawned.
21452145
added: v0.1.90
21462146
-->
21472147
2148-
* {stream.Writable|null|undefined}
2148+
* Type: {stream.Writable|null|undefined}
21492149
21502150
A `Writable Stream` that represents the child process's `stdin`.
21512151
@@ -2167,7 +2167,7 @@ if the child process could not be successfully spawned.
21672167
added: v0.7.10
21682168
-->
21692169
2170-
* {Array}
2170+
* Type: {Array}
21712171
21722172
A sparse array of pipes to the child process, corresponding with positions in
21732173
the [`stdio`][] option passed to [`child_process.spawn()`][] that have been set
@@ -2234,7 +2234,7 @@ not be successfully spawned.
22342234
added: v0.1.90
22352235
-->
22362236

2237-
* {stream.Readable|null|undefined}
2237+
* Type: {stream.Readable|null|undefined}
22382238

22392239
A `Readable Stream` that represents the child process's `stdout`.
22402240

‎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)
Back | FazBrowse Home | New Git URL