Skip to content

doc: fix typed list formatting #59019

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/api/async_context.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ asyncLocalStorage.getStore(); // Returns the same object
added: v24.0.0
-->

* {string}
* Type: {string}

The name of the `AsyncLocalStorage` instance if provided.

Expand Down
22 changes: 11 additions & 11 deletions doc/api/buffer.md
Original file line number Diff line number Diff line change
Expand Up @@ -1500,7 +1500,7 @@ console.log(Buffer.isEncoding(''));
added: v0.11.3
-->

* {integer} **Default:** `8192`
* Type: {integer} **Default:** `8192`

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

### `buf.buffer`

* {ArrayBuffer} The underlying `ArrayBuffer` object based on which this `Buffer`
* Type: {ArrayBuffer} The underlying `ArrayBuffer` object based on which this `Buffer`
object is created.

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

### `buf.byteOffset`

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

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

* {integer}
* Type: {integer}

Returns the number of bytes in `buf`.

Expand Down Expand Up @@ -5221,7 +5221,7 @@ added:
- v18.15.0
-->

* input {Buffer | ArrayBuffer | TypedArray} The input to validate.
* `input` {Buffer | ArrayBuffer | TypedArray} The input to validate.
* Returns: {boolean}

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

* input {Buffer | ArrayBuffer | TypedArray} The input to validate.
* `input` {Buffer | ArrayBuffer | TypedArray} The input to validate.
* Returns: {boolean}

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

* {integer} **Default:** `50`
* Type: {integer} **Default:** `50`

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

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

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

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

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

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

Expand Down Expand Up @@ -5367,7 +5367,7 @@ changes:
2<sup>32</sup> - 1 on 64-bit architectures.
-->

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

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

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

Represents the largest `length` that a `string` primitive can have, counted
in UTF-16 code units.
Expand Down
24 changes: 12 additions & 12 deletions doc/api/child_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -1604,7 +1604,7 @@ changes:
description: The object no longer accidentally exposes native C++ bindings.
-->

* {Object} A pipe representing the IPC channel to the child process.
* Type: {Object} A pipe representing the IPC channel to the child process.

The `subprocess.channel` property is a reference to the child's IPC channel. If
no IPC channel exists, this property is `undefined`.
Expand Down Expand Up @@ -1633,7 +1633,7 @@ running, and lets it finish even while the channel is open.
added: v0.7.2
-->

* {boolean} Set to `false` after `subprocess.disconnect()` is called.
* Type: {boolean} Set to `false` after `subprocess.disconnect()` is called.

The `subprocess.connected` property indicates whether it is still possible to
send and receive messages from a child process. When `subprocess.connected` is
Expand Down Expand Up @@ -1662,7 +1662,7 @@ within the child process to close the IPC channel as well.

### `subprocess.exitCode`

* {integer}
* Type: {integer}

The `subprocess.exitCode` property indicates the exit code of the child process.
If the child process is still running, the field will be `null`.
Expand Down Expand Up @@ -1787,7 +1787,7 @@ Calls [`subprocess.kill()`][] with `'SIGTERM'`.
added: v0.5.10
-->

* {boolean} Set to `true` after `subprocess.kill()` is used to successfully
* Type: {boolean} Set to `true` after `subprocess.kill()` is used to successfully
send a signal to the child process.

The `subprocess.killed` property indicates whether the child process
Expand All @@ -1800,7 +1800,7 @@ does not indicate that the child process has been terminated.
added: v0.1.90
-->

* {integer|undefined}
* Type: {integer|undefined}

Returns the process identifier (PID) of the child process. If the child process
fails to spawn due to errors, then the value is `undefined` and `error` is
Expand Down Expand Up @@ -2098,21 +2098,21 @@ connection to the child.

### `subprocess.signalCode`

* {string|null}
* Type: {string|null}

The `subprocess.signalCode` property indicates the signal received by
the child process if any, else `null`.

### `subprocess.spawnargs`

* {Array}
* Type: {Array}

The `subprocess.spawnargs` property represents the full list of command-line
arguments the child process was launched with.

### `subprocess.spawnfile`

* {string}
* Type: {string}

The `subprocess.spawnfile` property indicates the executable file name of
the child process that is launched.
Expand All @@ -2130,7 +2130,7 @@ in which the child process is launched.
added: v0.1.90
-->

* {stream.Readable|null|undefined}
* Type: {stream.Readable|null|undefined}

A `Readable Stream` that represents the child process's `stderr`.

Expand All @@ -2149,7 +2149,7 @@ if the child process could not be successfully spawned.
added: v0.1.90
-->

* {stream.Writable|null|undefined}
* Type: {stream.Writable|null|undefined}

A `Writable Stream` that represents the child process's `stdin`.

Expand All @@ -2171,7 +2171,7 @@ if the child process could not be successfully spawned.
added: v0.7.10
-->

* {Array}
* Type: {Array}

A sparse array of pipes to the child process, corresponding with positions in
the [`stdio`][] option passed to [`child_process.spawn()`][] that have been set
Expand Down Expand Up @@ -2238,7 +2238,7 @@ not be successfully spawned.
added: v0.1.90
-->

* {stream.Readable|null|undefined}
* Type: {stream.Readable|null|undefined}

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

Expand Down
16 changes: 8 additions & 8 deletions doc/api/cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -450,7 +450,7 @@ if (cluster.isPrimary) {
added: v6.0.0
-->

* {boolean}
* Type: {boolean}

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

* {integer}
* Type: {integer}

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

* {ChildProcess}
* Type: {ChildProcess}

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

* {boolean}
* Type: {boolean}

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

* {boolean}
* Type: {boolean}

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

Expand Down Expand Up @@ -919,7 +919,7 @@ changes:
description: The `stdio` option is supported now.
-->

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

* {Object}
* Type: {Object}

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

Expand Down Expand Up @@ -1060,7 +1060,7 @@ if (cluster.isPrimary) {
added: v0.7.0
-->

* {Object}
* Type: {Object}

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