archive/node
1
0
Fork 0
mirror of https://github.com/nodejs/node.git synced 2025-08-15 13:48:44 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

doc: fix typed list formatting

Browse source 
PR-URL: https://github.com/nodejs/node/pull/59019
Refs: https://github.com/nodejs/api-docs-tooling/issues/348
Reviewed-By: Chemi Atlow <chemi@atlow.co.il>
Reviewed-By: Zeyu "Alex" Yang <himself65@outlook.com>
Reviewed-By: Claudio Wunder <cwunder@gnome.org>
This commit is contained in:
Aviv Keller 2025-07-15 13:18:42 -04:00 • committed by GitHub
parent ce4a16f50a
commit 4102dcc226
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
39 changed files with 666 additions and 669 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/api/async_context.md
View file

@ -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.

22
doc/api/buffer.md
View file

@ -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.
@ -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
@ -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
@ -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`.
@ -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,
@ -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,
@ -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
@ -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`][].
@ -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`][].
@ -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).
@ -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.

24
doc/api/child_process.md
View file

@ -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`.
@ -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
@ -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`.
@ -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
@ -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
@ -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.
@ -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`.
@ -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`.
@ -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
@ -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`.

16
doc/api/cluster.md
View file

@ -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
@ -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`.
@ -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`
@ -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
@ -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`).
@ -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]`.
@ -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.
@ -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

70
doc/api/crypto.md
View file

@ -1995,15 +1995,15 @@ changes:
for RSA-PSS keys.
-->
* {Object}
* `modulusLength`: {number} Key size in bits (RSA, DSA).
* `publicExponent`: {bigint} Public exponent (RSA).
* `hashAlgorithm`: {string} Name of the message digest (RSA-PSS).
* `mgf1HashAlgorithm`: {string} Name of the message digest used by
* Type: {Object}
* `modulusLength` {number} Key size in bits (RSA, DSA).
* `publicExponent` {bigint} Public exponent (RSA).
* `hashAlgorithm` {string} Name of the message digest (RSA-PSS).
* `mgf1HashAlgorithm` {string} Name of the message digest used by
MGF1 (RSA-PSS).
* `saltLength`: {number} Minimal salt length in bytes (RSA-PSS).
* `divisorLength`: {number} Size of `q` in bits (DSA).
* `namedCurve`: {string} Name of the curve (EC).
* `saltLength` {number} Minimal salt length in bytes (RSA-PSS).
* `divisorLength` {number} Size of `q` in bits (DSA).
* `namedCurve` {string} Name of the curve (EC).
This property exists only on asymmetric keys. Depending on the type of the key,
this object contains information about the key. None of the information obtained
@ -2041,7 +2041,7 @@ changes:
description: Added support for `'ed25519'` and `'ed448'`.
-->
* {string}
* Type: {string}
For asymmetric keys, this property represents the type of the key. Supported key
types are:
@ -2067,7 +2067,7 @@ added:
- v16.15.0
-->
* `otherKeyObject`: {KeyObject} A `KeyObject` with which to
* `otherKeyObject` {KeyObject} A `KeyObject` with which to
compare `keyObject`.
* Returns: {boolean}
@ -2085,27 +2085,27 @@ changes:
description: Added support for `'jwk'` format.
-->
* `options`: {Object}
* `options` {Object}
* Returns: {string | Buffer | Object}
For symmetric keys, the following encoding options can be used:
* `format`: {string} Must be `'buffer'` (default) or `'jwk'`.
* `format` {string} Must be `'buffer'` (default) or `'jwk'`.
For public keys, the following encoding options can be used:
* `type`: {string} Must be one of `'pkcs1'` (RSA only) or `'spki'`.
* `format`: {string} Must be `'pem'`, `'der'`, or `'jwk'`.
* `type` {string} Must be one of `'pkcs1'` (RSA only) or `'spki'`.
* `format` {string} Must be `'pem'`, `'der'`, or `'jwk'`.
For private keys, the following encoding options can be used:
* `type`: {string} Must be one of `'pkcs1'` (RSA only), `'pkcs8'` or
* `type` {string} Must be one of `'pkcs1'` (RSA only), `'pkcs8'` or
`'sec1'` (EC only).
* `format`: {string} Must be `'pem'`, `'der'`, or `'jwk'`.
* `cipher`: {string} If specified, the private key will be encrypted with
* `format` {string} Must be `'pem'`, `'der'`, or `'jwk'`.
* `cipher` {string} If specified, the private key will be encrypted with
the given `cipher` and `passphrase` using PKCS#5 v2.0 password based
encryption.
* `passphrase`: {string | Buffer} The passphrase to use for encryption, see
* `passphrase` {string | Buffer} The passphrase to use for encryption, see
`cipher`.
The result type depends on the selected encoding format, when PEM the
@ -2131,7 +2131,7 @@ PKCS#1 and SEC1 encryption.
added: v11.6.0
-->
* {number}
* Type: {number}
For secret keys, this property represents the size of the key in bytes. This
property is `undefined` for asymmetric keys.
@ -2146,12 +2146,12 @@ added:
<!--lint disable maximum-line-length remark-lint-->
* `algorithm`: {string|Algorithm|RsaHashedImportParams|EcKeyImportParams|HmacImportParams}
* `algorithm` {string|Algorithm|RsaHashedImportParams|EcKeyImportParams|HmacImportParams}
<!--lint enable maximum-line-length remark-lint-->
* `extractable`: {boolean}
* `keyUsages`: {string\[]} See [Key usages][].
* `extractable` {boolean}
* `keyUsages` {string\[]} See [Key usages][].
* Returns: {CryptoKey}
Converts a `KeyObject` instance to a `CryptoKey`.
@ -2162,7 +2162,7 @@ Converts a `KeyObject` instance to a `CryptoKey`.
added: v11.6.0
-->
* {string}
* Type: {string}
Depending on the type of this `KeyObject`, this property is either
`'secret'` for secret (symmetric) keys, `'public'` for public (asymmetric) keys
@ -3005,7 +3005,7 @@ Checks the primality of the `candidate`.
added: v6.3.0
-->
* {Object}
* Type: {Object}
An object containing commonly used constants for crypto and security related
operations. The specific constants currently defined are described in
@ -3415,14 +3415,14 @@ changes:
<!--lint disable maximum-line-length remark-lint-->
* `key` {Object|string|ArrayBuffer|Buffer|TypedArray|DataView}
* `key`: {string|ArrayBuffer|Buffer|TypedArray|DataView|Object} The key
* `key` {string|ArrayBuffer|Buffer|TypedArray|DataView|Object} The key
material, either in PEM, DER, or JWK format.
* `format`: {string} Must be `'pem'`, `'der'`, or '`'jwk'`.
* `format` {string} Must be `'pem'`, `'der'`, or '`'jwk'`.
**Default:** `'pem'`.
* `type`: {string} Must be `'pkcs1'`, `'pkcs8'` or `'sec1'`. This option is
* `type` {string} Must be `'pkcs1'`, `'pkcs8'` or `'sec1'`. This option is
required only if the `format` is `'der'` and ignored otherwise.
* `passphrase`: {string | Buffer} The passphrase to use for decryption.
* `encoding`: {string} The string encoding to use when `key` is a string.
* `passphrase` {string | Buffer} The passphrase to use for decryption.
* `encoding` {string} The string encoding to use when `key` is a string.
* Returns: {KeyObject}
<!--lint enable maximum-line-length remark-lint-->
@ -3458,11 +3458,11 @@ changes:
<!--lint disable maximum-line-length remark-lint-->
* `key` {Object|string|ArrayBuffer|Buffer|TypedArray|DataView}
* `key`: {string|ArrayBuffer|Buffer|TypedArray|DataView|Object} The key
* `key` {string|ArrayBuffer|Buffer|TypedArray|DataView|Object} The key
material, either in PEM, DER, or JWK format.
* `format`: {string} Must be `'pem'`, `'der'`, or `'jwk'`.
* `format` {string} Must be `'pem'`, `'der'`, or `'jwk'`.
**Default:** `'pem'`.
* `type`: {string} Must be `'pkcs1'` or `'spki'`. This option is
* `type` {string} Must be `'pkcs1'` or `'spki'`. This option is
required only if the `format` is `'der'` and ignored otherwise.
* `encoding` {string} The string encoding to use when `key` is a string.
* Returns: {KeyObject}
@ -3561,9 +3561,9 @@ changes:
description: Optional callback argument added.
-->
* `options`: {Object}
* `privateKey`: {KeyObject}
* `publicKey`: {KeyObject}
* `options` {Object}
* `privateKey` {KeyObject}
* `publicKey` {KeyObject}
* `callback` {Function}
* `err` {Error}
* `secret` {Buffer}

2
doc/api/domain.md
View file

@ -287,7 +287,7 @@ To handle the errors that it catches, listen to its `'error'` event.
### `domain.members`
* {Array}
* Type: {Array}
An array of timers and event emitters that have been explicitly added
to the domain.

28
doc/api/errors.md
View file

@ -228,7 +228,7 @@ a();
### `Error.stackTraceLimit`
* {number}
* Type: {number}
The `Error.stackTraceLimit` property specifies the number of stack frames
collected by a stack trace (whether generated by `new Error().stack` or
@ -246,7 +246,7 @@ not capture any frames.
added: v16.9.0
-->
* {any}
* Type: {any}
If present, the `error.cause` property is the underlying cause of the `Error`.
It is used when catching an error and throwing a new one with a different
@ -285,7 +285,7 @@ console.log(symptom);
### `error.code`
* {string}
* Type: {string}
The `error.code` property is a string label that identifies the kind of error.
`error.code` is the most stable way to identify an error. It will only change
@ -295,7 +295,7 @@ about specific codes.
### `error.message`
* {string}
* Type: {string}
The `error.message` property is the string description of the error as set by
calling `new Error(message)`. The `message` passed to the constructor will also
@ -312,7 +312,7 @@ console.error(err.message);
### `error.stack`
* {string}
* Type: {string}
The `error.stack` property is a string describing the point in the code at which
the `Error` was instantiated.
@ -471,27 +471,27 @@ attempts to read a file that does not exist.
### `error.address`
* {string}
* Type: {string}
If present, `error.address` is a string describing the address to which a
network connection failed.
### `error.code`
* {string}
* Type: {string}
The `error.code` property is a string representing the error code.
### `error.dest`
* {string}
* Type: {string}
If present, `error.dest` is the file path destination when reporting a file
system error.
### `error.errno`
* {number}
* Type: {number}
The `error.errno` property is a negative number which corresponds
to the error code defined in [`libuv Error handling`][].
@ -503,31 +503,31 @@ To get the string representation of the error code, use
### `error.info`
* {Object}
* Type: {Object}
If present, `error.info` is an object with details about the error condition.
### `error.message`
* {string}
* Type: {string}
`error.message` is a system-provided human-readable description of the error.
### `error.path`
* {string}
* Type: {string}
If present, `error.path` is a string containing a relevant invalid pathname.
### `error.port`
* {number}
* Type: {number}
If present, `error.port` is the network connection port that is not available.
### `error.syscall`
* {string}
* Type: {string}
The `error.syscall` property is a string describing the [syscall][] that failed.

10
doc/api/esm.md
View file

@ -339,7 +339,7 @@ modules it can be used to load ES modules.
## `import.meta`
* {Object}
* Type: {Object}
The `import.meta` meta property is an `Object` that contains the following
properties. It is only supported in ES modules.
@ -358,7 +358,7 @@ changes:
description: This property is no longer experimental.
-->
* {string} The directory name of the current module.
* Type: {string} The directory name of the current module.
This is the same as the [`path.dirname()`][] of the [`import.meta.filename`][].
@ -378,7 +378,7 @@ changes:
description: This property is no longer experimental.
-->
* {string} The full absolute path and filename of the current module, with
* Type: {string} The full absolute path and filename of the current module, with
symlinks resolved.
This is the same as the [`url.fileURLToPath()`][] of the [`import.meta.url`][].
@ -388,7 +388,7 @@ This is the same as the [`url.fileURLToPath()`][] of the [`import.meta.url`][].
### `import.meta.url`
* {string} The absolute `file:` URL of the module.
* Type: {string} The absolute `file:` URL of the module.
This is defined exactly the same as it is in browsers providing the URL of the
current module file.
@ -409,7 +409,7 @@ added:
> Stability: 1.0 - Early development
* {boolean} `true` when the current module is the entry point of the current process; `false` otherwise.
* Type: {boolean} `true` when the current module is the entry point of the current process; `false` otherwise.
Equivalent to `require.main === module` in CommonJS.

2
doc/api/events.md
View file

@ -1988,7 +1988,7 @@ same options as `EventEmitter` and `AsyncResource` themselves.
### `eventemitterasyncresource.asyncResource`
* Type: The underlying {AsyncResource}.
* The underlying {AsyncResource}.
The returned `AsyncResource` object has an additional `eventEmitter` property
that provides a reference to this `EventEmitterAsyncResource`.

87
doc/api/fs.md
View file

@ -375,7 +375,7 @@ Unlike `filehandle.sync` this method does not flush modified metadata.
added: v10.0.0
-->
* {number} The numeric file descriptor managed by the {FileHandle} object.
* Type: {number} The numeric file descriptor managed by the {FileHandle} object.
#### `filehandle.read(buffer, offset, length, position)`
@ -1958,7 +1958,7 @@ added:
- v16.17.0
-->
* {Object}
* Type: {Object}
Returns an object containing commonly used constants for file system
operations. The object is the same as `fs.constants`. See [FS constants][]
@ -6453,8 +6453,7 @@ changes:
* `target` {string|Buffer|URL}
* `path` {string|Buffer|URL}
* `type` {string|null} **Default:** `null`
Returns `undefined`.
* Returns: `undefined`.
For detailed information, see the documentation of the asynchronous version of
this API: [`fs.symlink()`][].
@ -6511,8 +6510,7 @@ changes:
* `path` {string|Buffer|URL}
* `atime` {number|string|Date}
* `mtime` {number|string|Date}
Returns `undefined`.
* Returns: `undefined`.
For detailed information, see the documentation of the asynchronous version of
this API: [`fs.utimes()`][].
@ -6563,8 +6561,7 @@ changes:
* `flag` {string} See [support of file system `flags`][]. **Default:** `'w'`.
* `flush` {boolean} If all data is successfully written to the file, and
`flush` is `true`, `fs.fsyncSync()` is used to flush the data.
Returns `undefined`.
* Returns: `undefined`.
The `mode` option only affects the newly created file. See [`fs.open()`][]
for more details.
@ -6739,7 +6736,7 @@ Subsequent reads will result in errors.
added: v12.12.0
-->
* {string}
* Type: {string}
The read-only path of this directory as was provided to [`fs.opendir()`][],
[`fs.opendirSync()`][], or [`fsPromises.opendir()`][].
@ -6945,7 +6942,7 @@ Returns `true` if the {fs.Dirent} object describes a symbolic link.
added: v10.10.0
-->
* {string|Buffer}
* Type: {string|Buffer}
The file name that this {fs.Dirent} object refers to. The type of this
value is determined by the `options.encoding` passed to [`fs.readdir()`][] or
@ -6966,7 +6963,7 @@ changes:
description: Marking the API stable.
-->
* {string}
* Type: {string}
The path to the parent directory of the file this {fs.Dirent} object refers to.
@ -7167,7 +7164,7 @@ Fires immediately after `'open'`.
added: v6.4.0
-->
* {number}
* Type: {number}
The number of bytes that have been read so far.
@ -7177,7 +7174,7 @@ The number of bytes that have been read so far.
added: v0.1.93
-->
* {string|Buffer}
* Type: {string|Buffer}
The path to the file the stream is reading from as specified in the first
argument to `fs.createReadStream()`. If `path` is passed as a string, then
@ -7193,7 +7190,7 @@ added:
- v10.16.0
-->
* {boolean}
* Type: {boolean}
This property is `true` if the underlying file has not been opened yet,
i.e. before the `'ready'` event is emitted.
@ -7352,49 +7349,49 @@ This method is only valid when using [`fs.lstat()`][].
#### `stats.dev`
* {number|bigint}
* Type: {number|bigint}
The numeric identifier of the device containing the file.
#### `stats.ino`
* {number|bigint}
* Type: {number|bigint}
The file system specific "Inode" number for the file.
#### `stats.mode`
* {number|bigint}
* Type: {number|bigint}
A bit-field describing the file type and mode.
#### `stats.nlink`
* {number|bigint}
* Type: {number|bigint}
The number of hard-links that exist for the file.
#### `stats.uid`
* {number|bigint}
* Type: {number|bigint}
The numeric user identifier of the user that owns the file (POSIX).
#### `stats.gid`
* {number|bigint}
* Type: {number|bigint}
The numeric group identifier of the group that owns the file (POSIX).
#### `stats.rdev`
* {number|bigint}
* Type: {number|bigint}
A numeric device identifier if the file represents a device.
#### `stats.size`
* {number|bigint}
* Type: {number|bigint}
The size of the file in bytes.
@ -7403,13 +7400,13 @@ this will be `0`.
#### `stats.blksize`
* {number|bigint}
* Type: {number|bigint}
The file system block size for i/o operations.
#### `stats.blocks`
* {number|bigint}
* Type: {number|bigint}
The number of blocks allocated for this file.
@ -7419,7 +7416,7 @@ The number of blocks allocated for this file.
added: v8.1.0
-->
* {number|bigint}
* Type: {number|bigint}
The timestamp indicating the last time this file was accessed expressed in
milliseconds since the POSIX Epoch.
@ -7430,7 +7427,7 @@ milliseconds since the POSIX Epoch.
added: v8.1.0
-->
* {number|bigint}
* Type: {number|bigint}
The timestamp indicating the last time this file was modified expressed in
milliseconds since the POSIX Epoch.
@ -7441,7 +7438,7 @@ milliseconds since the POSIX Epoch.
added: v8.1.0
-->
* {number|bigint}
* Type: {number|bigint}
The timestamp indicating the last time the file status was changed expressed
in milliseconds since the POSIX Epoch.
@ -7452,7 +7449,7 @@ in milliseconds since the POSIX Epoch.
added: v8.1.0
-->
* {number|bigint}
* Type: {number|bigint}
The timestamp indicating the creation time of this file expressed in
milliseconds since the POSIX Epoch.
@ -7463,7 +7460,7 @@ milliseconds since the POSIX Epoch.
added: v12.10.0
-->
* {bigint}
* Type: {bigint}
Only present when `bigint: true` is passed into the method that generates
the object.
@ -7476,7 +7473,7 @@ nanoseconds since the POSIX Epoch.
added: v12.10.0
-->
* {bigint}
* Type: {bigint}
Only present when `bigint: true` is passed into the method that generates
the object.
@ -7489,7 +7486,7 @@ nanoseconds since the POSIX Epoch.
added: v12.10.0
-->
* {bigint}
* Type: {bigint}
Only present when `bigint: true` is passed into the method that generates
the object.
@ -7502,7 +7499,7 @@ in nanoseconds since the POSIX Epoch.
added: v12.10.0
-->
* {bigint}
* Type: {bigint}
Only present when `bigint: true` is passed into the method that generates
the object.
@ -7515,7 +7512,7 @@ nanoseconds since the POSIX Epoch.
added: v0.11.13
-->
* {Date}
* Type: {Date}
The timestamp indicating the last time this file was accessed.
@ -7525,7 +7522,7 @@ The timestamp indicating the last time this file was accessed.
added: v0.11.13
-->
* {Date}
* Type: {Date}
The timestamp indicating the last time this file was modified.
@ -7535,7 +7532,7 @@ The timestamp indicating the last time this file was modified.
added: v0.11.13
-->
* {Date}
* Type: {Date}
The timestamp indicating the last time the file status was changed.
@ -7545,7 +7542,7 @@ The timestamp indicating the last time the file status was changed.
added: v0.11.13
-->
* {Date}
* Type: {Date}
The timestamp indicating the creation time of this file.
@ -7637,7 +7634,7 @@ added:
- v18.15.0
-->
* {number|bigint}
* Type: {number|bigint}
Free blocks available to unprivileged users.
@ -7649,7 +7646,7 @@ added:
- v18.15.0
-->
* {number|bigint}
* Type: {number|bigint}
Free blocks in file system.
@ -7661,7 +7658,7 @@ added:
- v18.15.0
-->
* {number|bigint}
* Type: {number|bigint}
Total data blocks in file system.
@ -7673,7 +7670,7 @@ added:
- v18.15.0
-->
* {number|bigint}
* Type: {number|bigint}
Optimal transfer block size.
@ -7685,7 +7682,7 @@ added:
- v18.15.0
-->
* {number|bigint}
* Type: {number|bigint}
Free file nodes in file system.
@ -7697,7 +7694,7 @@ added:
- v18.15.0
-->
* {number|bigint}
* Type: {number|bigint}
Total file nodes in file system.
@ -7709,7 +7706,7 @@ added:
- v18.15.0
-->
* {number|bigint}
* Type: {number|bigint}
Type of file system.
@ -7791,14 +7788,14 @@ argument to [`fs.createWriteStream()`][]. If `path` is passed as a string, then
added: v11.2.0
-->
* {boolean}
* Type: {boolean}
This property is `true` if the underlying file has not been opened yet,
i.e. before the `'ready'` event is emitted.
### `fs.constants`
* {Object}
* Type: {Object}
Returns an object containing commonly used constants for file system
operations.

22
doc/api/globals.md
View file

@ -104,7 +104,7 @@ changes:
description: Added the new optional reason argument.
-->
* `reason`: {any}
* `reason` {any}
* Returns: {AbortSignal}
Returns a new already aborted `AbortSignal`.
@ -238,7 +238,7 @@ See {Blob}.
added: v0.1.103
-->
* {Function}
* Type: {Function}
Used to handle binary data. See the [buffer section][].
@ -345,7 +345,7 @@ A browser-compatible implementation of [`CompressionStream`][].
added: v0.1.100
-->
* {Object}
* Type: {Object}
Used to print to stdout and stderr. See the [`console`][] section.
@ -589,7 +589,7 @@ added: v0.1.27
> Stability: 3 - Legacy. Use [`globalThis`][] instead.
* {Object} The global namespace object.
* Type: {Object} The global namespace object.
In browsers, the top-level scope has traditionally been the global scope. This
means that `var something` will define a new global variable, except within
@ -688,7 +688,7 @@ A partial implementation of [`window.navigator`][].
added: v21.0.0
-->
* {number}
* Type: {number}
The `navigator.hardwareConcurrency` read-only property returns the number of
logical processors available to the current Node.js instance.
@ -703,7 +703,7 @@ console.log(`This process is running on ${navigator.hardwareConcurrency} logical
added: v21.2.0
-->
* {string}
* Type: {string}
The `navigator.language` read-only property returns a string representing the
preferred language of the Node.js instance. The language will be determined by
@ -724,7 +724,7 @@ console.log(`The preferred language of the Node.js instance has the tag '${navig
added: v21.2.0
-->
* {Array<string>}
* Type: {Array<string>}
The `navigator.languages` read-only property returns an array of strings
representing the preferred languages of the Node.js instance.
@ -744,7 +744,7 @@ console.log(`The preferred languages are '${navigator.languages}'`);
added: v21.2.0
-->
* {string}
* Type: {string}
The `navigator.platform` read-only property returns a string identifying the
platform on which the Node.js instance is running.
@ -759,7 +759,7 @@ console.log(`This process is running on ${navigator.platform}`);
added: v21.1.0
-->
* {string}
* Type: {string}
The `navigator.userAgent` read-only property returns user agent
consisting of the runtime name and major version number.
@ -832,7 +832,7 @@ The [`perf_hooks.performance`][] object.
added: v0.1.7
-->
* {Object}
* Type: {Object}
The process object. See the [`process` object][] section.
@ -1181,7 +1181,7 @@ The WHATWG `URLSearchParams` class. See the [`URLSearchParams`][] section.
added: v8.0.0
-->
* {Object}
* Type: {Object}
The object that acts as the namespace for all W3C
[WebAssembly][webassembly-org] related functionality. See the

126
doc/api/http.md
View file

@ -291,7 +291,7 @@ changes:
description: The property now has a `null` prototype.
-->
* {Object}
* Type: {Object}
An object which contains arrays of sockets currently awaiting use by
the agent when `keepAlive` is enabled. Do not modify.
@ -332,7 +332,7 @@ that determine socket reusability.
added: v0.11.7
-->
* {number}
* Type: {number}
By default set to 256. For agents with `keepAlive` enabled, this
sets the maximum number of sockets that will be left open in the free
@ -344,7 +344,7 @@ state.
added: v0.3.6
-->
* {number}
* Type: {number}
By default set to `Infinity`. Determines how many concurrent sockets the agent
can have open per origin. Origin is the returned value of [`agent.getName()`][].
@ -357,7 +357,7 @@ added:
- v12.19.0
-->
* {number}
* Type: {number}
By default set to `Infinity`. Determines how many concurrent sockets the agent
can have open. Unlike `maxSockets`, this parameter applies across all origins.
@ -372,7 +372,7 @@ changes:
description: The property now has a `null` prototype.
-->
* {Object}
* Type: {Object}
An object which contains queues of requests that have not yet been assigned to
sockets. Do not modify.
@ -387,7 +387,7 @@ changes:
description: The property now has a `null` prototype.
-->
* {Object}
* Type: {Object}
An object which contains arrays of sockets currently in use by the
agent. Do not modify.
@ -836,7 +836,7 @@ changes:
> Stability: 0 - Deprecated. Check [`request.destroyed`][] instead.
* {boolean}
* Type: {boolean}
The `request.aborted` property will be `true` if the request has
been aborted.
@ -850,7 +850,7 @@ deprecated: v13.0.0
> Stability: 0 - Deprecated. Use [`request.socket`][].
* {stream.Duplex}
* Type: {stream.Duplex}
See [`request.socket`][].
@ -920,7 +920,7 @@ added:
- v13.14.0
-->
* {boolean}
* Type: {boolean}
Is `true` after [`request.destroy()`][] has been called.
@ -937,7 +937,7 @@ deprecated:
> Stability: 0 - Deprecated. Use [`request.writableEnded`][].
* {boolean}
* Type: {boolean}
The `request.finished` property will be `true` if [`request.end()`][]
has been called. `request.end()` will automatically be called if the
@ -1069,7 +1069,7 @@ const hasContentType = request.hasHeader('content-type');
### `request.maxHeadersCount`
* {number} **Default:** `2000`
* Type: {number} **Default:** `2000`
Limits maximum response headers count. If set to 0, no limit will be applied.
@ -1079,7 +1079,7 @@ Limits maximum response headers count. If set to 0, no limit will be applied.
added: v0.4.0
-->
* {string} The request path.
* Type: {string} The request path.
### `request.method`
@ -1087,7 +1087,7 @@ added: v0.4.0
added: v0.1.97
-->
* {string} The request method.
* Type: {string} The request method.
### `request.host`
@ -1097,7 +1097,7 @@ added:
- v12.19.0
-->
* {string} The request host.
* Type: {string} The request host.
### `request.protocol`
@ -1107,7 +1107,7 @@ added:
- v12.19.0
-->
* {string} The request protocol.
* Type: {string} The request protocol.
### `request.removeHeader(name)`
@ -1131,7 +1131,7 @@ added:
- v12.16.0
-->
* {boolean} Whether the request is send through a reused socket.
* Type: {boolean} Whether the request is send through a reused socket.
When sending request through a keep-alive enabled agent, the underlying socket
might be reused. But if server closes connection at unfortunate time, client
@ -1306,7 +1306,7 @@ Once a socket is assigned to this request and is connected
added: v0.3.0
-->
* {stream.Duplex}
* Type: {stream.Duplex}
Reference to the underlying socket. Usually users will not want to access
this property. In particular, the socket will not emit `'readable'` events
@ -1362,7 +1362,7 @@ See [`writable.uncork()`][].
added: v12.9.0
-->
* {boolean}
* Type: {boolean}
Is `true` after [`request.end()`][] has been called. This property
does not indicate whether the data has been flushed, for this use
@ -1374,7 +1374,7 @@ does not indicate whether the data has been flushed, for this use
added: v12.7.0
-->
* {boolean}
* Type: {boolean}
Is `true` if all data has been flushed to the underlying system, immediately
before the [`'finish'`][] event is emitted.
@ -1790,7 +1790,7 @@ changes:
description: The default is now set to the minimum between 60000 (60 seconds) or `requestTimeout`.
-->
* {number} **Default:** The minimum between [`server.requestTimeout`][] or `60000`.
* Type: {number} **Default:** The minimum between [`server.requestTimeout`][] or `60000`.
Limit the amount of time the parser will wait to receive the complete HTTP
headers.
@ -1813,7 +1813,7 @@ This method is identical to [`server.listen()`][] from [`net.Server`][].
added: v5.7.0
-->
* {boolean} Indicates whether or not the server is listening for connections.
* Type: {boolean} Indicates whether or not the server is listening for connections.
### `server.maxHeadersCount`
@ -1821,7 +1821,7 @@ added: v5.7.0
added: v0.7.0
-->
* {number} **Default:** `2000`
* Type: {number} **Default:** `2000`
Limits maximum incoming headers count. If set to 0, no limit will be applied.
@ -1836,7 +1836,7 @@ changes:
from no timeout to 300s (5 minutes).
-->
* {number} **Default:** `300000`
* Type: {number} **Default:** `300000`
Sets the timeout value in milliseconds for receiving the entire request from
the client.
@ -1879,7 +1879,7 @@ explicitly.
added: v16.10.0
-->
* {number} Requests per socket. **Default:** 0 (no limit)
* Type: {number} Requests per socket. **Default:** 0 (no limit)
The maximum number of requests socket can handle
before closing keep alive connection.
@ -1900,7 +1900,7 @@ changes:
description: The default timeout changed from 120s to 0 (no timeout).
-->
* {number} Timeout in milliseconds. **Default:** 0 (no timeout)
* Type: {number} Timeout in milliseconds. **Default:** 0 (no timeout)
The number of milliseconds of inactivity before a socket is presumed
to have timed out.
@ -1916,7 +1916,7 @@ value only affects new connections to the server, not any existing connections.
added: v8.0.0
-->
* {number} Timeout in milliseconds. **Default:** `5000` (5 seconds).
* Type: {number} Timeout in milliseconds. **Default:** `5000` (5 seconds).
The number of milliseconds of inactivity a server needs to wait for additional
incoming data, after it has finished writing the last response, before a socket
@ -2014,7 +2014,7 @@ deprecated: v13.0.0
> Stability: 0 - Deprecated. Use [`response.socket`][].
* {stream.Duplex}
* Type: {stream.Duplex}
See [`response.socket`][].
@ -2067,7 +2067,7 @@ deprecated:
> Stability: 0 - Deprecated. Use [`response.writableEnded`][].
* {boolean}
* Type: {boolean}
The `response.finished` property will be `true` if [`response.end()`][]
has been called.
@ -2173,7 +2173,7 @@ const hasContentType = response.hasHeader('content-type');
added: v0.9.3
-->
* {boolean}
* Type: {boolean}
Boolean (read-only). True if headers were sent, false otherwise.
@ -2197,7 +2197,7 @@ response.removeHeader('Content-Encoding');
added: v15.7.0
-->
* {http.IncomingMessage}
* Type: {http.IncomingMessage}
A reference to the original HTTP `request` object.
@ -2207,7 +2207,7 @@ A reference to the original HTTP `request` object.
added: v0.7.5
-->
* {boolean}
* Type: {boolean}
When true, the Date header will be automatically generated and sent in
the response if it is not already present in the headers. Defaults to true.
@ -2294,7 +2294,7 @@ timed out sockets must be handled explicitly.
added: v0.3.0
-->
* {stream.Duplex}
* Type: {stream.Duplex}
Reference to the underlying socket. Usually users will not want to access
this property. In particular, the socket will not emit `'readable'` events
@ -2329,7 +2329,7 @@ type other than {net.Socket}.
added: v0.4.0
-->
* {number} **Default:** `200`
* Type: {number} **Default:** `200`
When using implicit headers (not calling [`response.writeHead()`][] explicitly),
this property controls the status code that will be sent to the client when
@ -2348,7 +2348,7 @@ status code which was sent out.
added: v0.11.8
-->
* {string}
* Type: {string}
When using implicit headers (not calling [`response.writeHead()`][] explicitly),
this property controls the status message that will be sent to the client when
@ -2370,7 +2370,7 @@ added:
- v16.18.0
-->
* {boolean} **Default:** `false`
* Type: {boolean} **Default:** `false`
If set to `true`, Node.js will check whether the `Content-Length`
header value and the size of the body, in bytes, are equal.
@ -2393,7 +2393,7 @@ See [`writable.uncork()`][].
added: v12.9.0
-->
* {boolean}
* Type: {boolean}
Is `true` after [`response.end()`][] has been called. This property
does not indicate whether the data has been flushed, for this use
@ -2405,7 +2405,7 @@ does not indicate whether the data has been flushed, for this use
added: v12.7.0
-->
* {boolean}
* Type: {boolean}
Is `true` if all data has been flushed to the underlying system, immediately
before the [`'finish'`][] event is emitted.
@ -2664,7 +2664,7 @@ deprecated:
> Stability: 0 - Deprecated. Check `message.destroyed` from {stream.Readable}.
* {boolean}
* Type: {boolean}
The `message.aborted` property will be `true` if the request has
been aborted.
@ -2675,7 +2675,7 @@ been aborted.
added: v0.3.0
-->
* {boolean}
* Type: {boolean}
The `message.complete` property will be `true` if a complete HTTP message has
been received and successfully parsed.
@ -2750,7 +2750,7 @@ changes:
on the prototype and is no longer enumerable.
-->
* {Object}
* Type: {Object}
The request/response headers object.
@ -2788,7 +2788,7 @@ added:
- v16.17.0
-->
* {Object}
* Type: {Object}
Similar to [`message.headers`][], but there is no join logic and the values are
always arrays of strings, even for headers received just once.
@ -2808,7 +2808,7 @@ console.log(request.headersDistinct);
added: v0.1.1
-->
* {string}
* Type: {string}
In case of server request, the HTTP version sent by the client. In the case of
client response, the HTTP version of the connected-to server.
@ -2823,7 +2823,7 @@ Also `message.httpVersionMajor` is the first integer and
added: v0.1.1
-->
* {string}
* Type: {string}
**Only valid for request obtained from [`http.Server`][].**
@ -2835,7 +2835,7 @@ The request method as a string. Read only. Examples: `'GET'`, `'DELETE'`.
added: v0.11.6
-->
* {string\[]}
* Type: {string\[]}
The raw request/response headers list exactly as they were received.
@ -2865,7 +2865,7 @@ console.log(request.rawHeaders);
added: v0.11.6
-->
* {string\[]}
* Type: {string\[]}
The raw request/response trailer keys and values exactly as they were
received. Only populated at the `'end'` event.
@ -2888,7 +2888,7 @@ Calls `message.socket.setTimeout(msecs, callback)`.
added: v0.3.0
-->
* {stream.Duplex}
* Type: {stream.Duplex}
The [`net.Socket`][] object associated with the connection.
@ -2905,7 +2905,7 @@ type other than {net.Socket} or internally nulled.
added: v0.1.1
-->
* {number}
* Type: {number}
**Only valid for response obtained from [`http.ClientRequest`][].**
@ -2917,7 +2917,7 @@ The 3-digit HTTP response status code. E.G. `404`.
added: v0.11.10
-->
* {string}
* Type: {string}
**Only valid for response obtained from [`http.ClientRequest`][].**
@ -2930,7 +2930,7 @@ Error`.
added: v0.3.0
-->
* {Object}
* Type: {Object}
The request/response trailers object. Only populated at the `'end'` event.
@ -2942,7 +2942,7 @@ added:
- v16.17.0
-->
* {Object}
* Type: {Object}
Similar to [`message.trailers`][], but there is no join logic and the values are
always arrays of strings, even for headers received just once.
@ -2954,7 +2954,7 @@ Only populated at the `'end'` event.
added: v0.1.90
-->
* {string}
* Type: {string}
**Only valid for request obtained from [`http.Server`][].**
@ -3238,7 +3238,7 @@ const hasContentType = outgoingMessage.hasHeader('content-type');
added: v0.9.3
-->
* {boolean}
* Type: {boolean}
Read-only. `true` if the headers were sent, otherwise `false`.
@ -3344,7 +3344,7 @@ Once a socket is associated with the message and is connected,
added: v0.3.0
-->
* {stream.Duplex}
* Type: {stream.Duplex}
Reference to the underlying socket. Usually, users will not want to access
this property.
@ -3369,7 +3369,7 @@ added:
- v12.16.0
-->
* {number}
* Type: {number}
The number of times `outgoingMessage.cork()` has been called.
@ -3379,7 +3379,7 @@ The number of times `outgoingMessage.cork()` has been called.
added: v12.9.0
-->
* {boolean}
* Type: {boolean}
Is `true` if `outgoingMessage.end()` has been called. This property does
not indicate whether the data has been flushed. For that purpose, use
@ -3391,7 +3391,7 @@ not indicate whether the data has been flushed. For that purpose, use
added: v12.7.0
-->
* {boolean}
* Type: {boolean}
Is `true` if all data has been flushed to the underlying system.
@ -3401,7 +3401,7 @@ Is `true` if all data has been flushed to the underlying system.
added: v12.9.0
-->
* {number}
* Type: {number}
The `highWaterMark` of the underlying socket if assigned. Otherwise, the default
buffer level when [`writable.write()`][] starts returning false (`16384`).
@ -3412,7 +3412,7 @@ buffer level when [`writable.write()`][] starts returning false (`16384`).
added: v12.9.0
-->
* {number}
* Type: {number}
The number of buffered bytes.
@ -3422,7 +3422,7 @@ The number of buffered bytes.
added: v12.9.0
-->
* {boolean}
* Type: {boolean}
Always `false`.
@ -3461,7 +3461,7 @@ memory. The `'drain'` event will be emitted when the buffer is free again.
added: v0.11.8
-->
* {string\[]}
* Type: {string\[]}
A list of the HTTP methods that are supported by the parser.
@ -3471,7 +3471,7 @@ A list of the HTTP methods that are supported by the parser.
added: v0.1.22
-->
* {Object}
* Type: {Object}
A collection of all the standard HTTP response status codes, and the
short description of each. For example, `http.STATUS_CODES[404] === 'Not
@ -3742,7 +3742,7 @@ changes:
default.
-->
* {http.Agent}
* Type: {http.Agent}
Global instance of `Agent` which is used as the default for all HTTP client
requests. Diverges from a default `Agent` configuration by having `keepAlive`
@ -3756,7 +3756,7 @@ added:
- v10.15.0
-->
* {number}
* Type: {number}
Read-only property specifying the maximum allowed size of HTTP headers in bytes.
Defaults to 16 KiB. Configurable using the [`--max-http-header-size`][] CLI

110
doc/api/http2.md
View file

@ -451,7 +451,7 @@ session.on('timeout', () => { /* .. */ });
added: v9.4.0
-->
* {string|undefined}
* Type: {string|undefined}
Value will be `undefined` if the `Http2Session` is not yet connected to a
socket, `h2c` if the `Http2Session` is not connected to a `TLSSocket`, or
@ -480,7 +480,7 @@ If specified, the `callback` function is registered as a handler for the
added: v9.4.0
-->
* {boolean}
* Type: {boolean}
Will be `true` if this `Http2Session` instance has been closed, otherwise
`false`.
@ -491,7 +491,7 @@ Will be `true` if this `Http2Session` instance has been closed, otherwise
added: v10.0.0
-->
* {boolean}
* Type: {boolean}
Will be `true` if this `Http2Session` instance is still connecting, will be set
to `false` before emitting `connect` event and/or calling the `http2.connect`
@ -525,7 +525,7 @@ If there are any remaining open `Http2Streams` associated with the
added: v8.4.0
-->
* {boolean}
* Type: {boolean}
Will be `true` if this `Http2Session` instance has been destroyed and must no
longer be used, otherwise `false`.
@ -536,7 +536,7 @@ longer be used, otherwise `false`.
added: v9.4.0
-->
* {boolean|undefined}
* Type: {boolean|undefined}
Value is `undefined` if the `Http2Session` session socket has not yet been
connected, `true` if the `Http2Session` is connected with a `TLSSocket`,
@ -563,7 +563,7 @@ Transmits a `GOAWAY` frame to the connected peer _without_ shutting down the
added: v8.4.0
-->
* {HTTP/2 Settings Object}
* Type: {HTTP/2 Settings Object}
A prototype-less object describing the current local settings of this
`Http2Session`. The local settings are local to _this_ `Http2Session` instance.
@ -574,7 +574,7 @@ A prototype-less object describing the current local settings of this
added: v9.4.0
-->
* {string\[]|undefined}
* Type: {string\[]|undefined}
If the `Http2Session` is connected to a `TLSSocket`, the `originSet` property
will return an `Array` of origins for which the `Http2Session` may be
@ -588,7 +588,7 @@ The `originSet` property is only available when using a secure TLS connection.
added: v8.4.0
-->
* {boolean}
* Type: {boolean}
Indicates whether the `Http2Session` is currently waiting for acknowledgment of
a sent `SETTINGS` frame. Will be `true` after calling the
@ -655,7 +655,7 @@ instance's underlying [`net.Socket`][].
added: v8.4.0
-->
* {HTTP/2 Settings Object}
* Type: {HTTP/2 Settings Object}
A prototype-less object describing the current remote settings of this
`Http2Session`. The remote settings are set by the _connected_ HTTP/2 peer.
@ -725,7 +725,7 @@ registered as a listener on the `'timeout'` event.
added: v8.4.0
-->
* {net.Socket|tls.TLSSocket}
* Type: {net.Socket|tls.TLSSocket}
Returns a `Proxy` object that acts as a `net.Socket` (or `tls.TLSSocket`) but
limits available methods to ones safe to use with HTTP/2.
@ -747,7 +747,7 @@ added: v8.4.0
Provides miscellaneous information about the current state of the
`Http2Session`.
* {Object}
* Type: {Object}
* `effectiveLocalWindowSize` {number} The current local (receive)
flow control window size for the `Http2Session`.
* `effectiveRecvDataLength` {number} The current number of bytes
@ -805,7 +805,7 @@ multiple `SETTINGS` frames while acknowledgment is still pending.
added: v8.4.0
-->
* {number}
* Type: {number}
The `http2session.type` will be equal to
`http2.constants.NGHTTP2_SESSION_SERVER` if this `Http2Session` instance is a
@ -1084,7 +1084,7 @@ changes:
`weight` option is deprecated.
-->
* `headers` {HTTP/2 Headers Object} | {Array}
* `headers` {HTTP/2 Headers Object|Array}
* `options` {Object}
* `endStream` {boolean} `true` if the `Http2Stream` _writable_ side should
@ -1368,7 +1368,7 @@ option must be set for this event to be emitted.
added: v8.4.0
-->
* {boolean}
* Type: {boolean}
Set to `true` if the `Http2Stream` instance was aborted abnormally. When set,
the `'aborted'` event will have been emitted.
@ -1381,7 +1381,7 @@ added:
- v10.16.0
-->
* {number}
* Type: {number}
This property shows the number of characters currently buffered to be written.
See [`net.Socket.bufferSize`][] for details.
@ -1412,7 +1412,7 @@ connected HTTP/2 peer.
added: v9.4.0
-->
* {boolean}
* Type: {boolean}
Set to `true` if the `Http2Stream` instance has been closed.
@ -1422,7 +1422,7 @@ Set to `true` if the `Http2Stream` instance has been closed.
added: v8.4.0
-->
* {boolean}
* Type: {boolean}
Set to `true` if the `Http2Stream` instance has been destroyed and is no longer
usable.
@ -1433,7 +1433,7 @@ usable.
added: v10.11.0
-->
* {boolean}
* Type: {boolean}
Set to `true` if the `END_STREAM` flag was set in the request or response
HEADERS frame received, indicating that no additional data should be received
@ -1445,7 +1445,7 @@ and the readable side of the `Http2Stream` will be closed.
added: v8.4.0
-->
* {number|undefined}
* Type: {number|undefined}
The numeric stream identifier of this `Http2Stream` instance. Set to `undefined`
if the stream identifier has not yet been assigned.
@ -1456,7 +1456,7 @@ if the stream identifier has not yet been assigned.
added: v9.4.0
-->
* {boolean}
* Type: {boolean}
Set to `true` if the `Http2Stream` instance has not yet been assigned a
numeric stream identifier.
@ -1486,7 +1486,7 @@ Empty method, only there to maintain some backward compatibility.
added: v8.4.0
-->
* {number}
* Type: {number}
Set to the `RST_STREAM` [error code][] reported when the `Http2Stream` is
destroyed after either receiving an `RST_STREAM` frame from the connected peer,
@ -1499,7 +1499,7 @@ calling `http2stream.close()`, or `http2stream.destroy()`. Will be
added: v9.5.0
-->
* {HTTP/2 Headers Object}
* Type: {HTTP/2 Headers Object}
An object containing the outbound headers sent for this `Http2Stream`.
@ -1509,7 +1509,7 @@ An object containing the outbound headers sent for this `Http2Stream`.
added: v9.5.0
-->
* {HTTP/2 Headers Object\[]}
* Type: {HTTP/2 Headers Object\[]}
An array of objects containing the outbound informational (additional) headers
sent for this `Http2Stream`.
@ -1520,7 +1520,7 @@ sent for this `Http2Stream`.
added: v9.5.0
-->
* {HTTP/2 Headers Object}
* Type: {HTTP/2 Headers Object}
An object containing the outbound trailers sent for this `HttpStream`.
@ -1530,7 +1530,7 @@ An object containing the outbound trailers sent for this `HttpStream`.
added: v8.4.0
-->
* {Http2Session}
* Type: {Http2Session}
A reference to the `Http2Session` instance that owns this `Http2Stream`. The
value will be `undefined` after the `Http2Stream` instance is destroyed.
@ -1590,7 +1590,7 @@ changes:
Provides miscellaneous information about the current state of the
`Http2Stream`.
* {Object}
* Type: {Object}
* `localWindowSize` {number} The number of bytes the connected peer may send
for this `Http2Stream` without receiving a `WINDOW_UPDATE`.
* `state` {number} A flag indicating the low-level current state of the
@ -1768,7 +1768,7 @@ Sends an additional informational `HEADERS` frame to the connected HTTP/2 peer.
added: v8.4.0
-->
* {boolean}
* Type: {boolean}
True if headers were sent, false otherwise (read-only).
@ -1778,7 +1778,7 @@ True if headers were sent, false otherwise (read-only).
added: v8.4.0
-->
* {boolean}
* Type: {boolean}
Read-only property mapped to the `SETTINGS_ENABLE_PUSH` flag of the remote
client's most recent `SETTINGS` frame. Will be `true` if the remote peer
@ -2483,7 +2483,7 @@ changes:
description: The default timeout changed from 120s to 0 (no timeout).
-->
* {number} Timeout in milliseconds. **Default:** 0 (no timeout)
* Type: {number} Timeout in milliseconds. **Default:** 0 (no timeout)
The number of milliseconds of inactivity before a socket is presumed
to have timed out.
@ -2752,7 +2752,7 @@ changes:
description: The default timeout changed from 120s to 0 (no timeout).
-->
* {number} Timeout in milliseconds. **Default:** 0 (no timeout)
* Type: {number} Timeout in milliseconds. **Default:** 0 (no timeout)
The number of milliseconds of inactivity before a socket is presumed
to have timed out.
@ -3384,7 +3384,7 @@ added:
- v14.18.0
-->
* {symbol}
* Type: {symbol}
This symbol can be set as a property on the HTTP/2 headers object with an array
value in order to provide a list of headers considered sensitive.
@ -3948,7 +3948,7 @@ Just like `'end'`, this event occurs only once per response.
added: v10.1.0
-->
* {boolean}
* Type: {boolean}
The `request.aborted` property will be `true` if the request has
been aborted.
@ -3959,7 +3959,7 @@ been aborted.
added: v8.4.0
-->
* {string}
* Type: {string}
The request authority pseudo header field. Because HTTP/2 allows requests
to set either `:authority` or `host`, this value is derived from
@ -3972,7 +3972,7 @@ to set either `:authority` or `host`, this value is derived from
added: v12.10.0
-->
* {boolean}
* Type: {boolean}
The `request.complete` property will be `true` if the request has
been completed, aborted, or destroyed.
@ -3986,7 +3986,7 @@ deprecated: v13.0.0
> Stability: 0 - Deprecated. Use [`request.socket`][].
* {net.Socket|tls.TLSSocket}
* Type: {net.Socket|tls.TLSSocket}
See [`request.socket`][].
@ -4010,7 +4010,7 @@ It does nothing if the stream was already destroyed.
added: v8.4.0
-->
* {Object}
* Type: {Object}
The request/response headers object.
@ -4044,7 +4044,7 @@ assert(request.url); // Fails because the :path header has been removed
added: v8.4.0
-->
* {string}
* Type: {string}
In case of server request, the HTTP version sent by the client. In the case of
client response, the HTTP version of the connected-to server. Returns
@ -4059,7 +4059,7 @@ Also `message.httpVersionMajor` is the first integer and
added: v8.4.0
-->
* {string}
* Type: {string}
The request method as a string. Read-only. Examples: `'GET'`, `'DELETE'`.
@ -4069,7 +4069,7 @@ The request method as a string. Read-only. Examples: `'GET'`, `'DELETE'`.
added: v8.4.0
-->
* {string\[]}
* Type: {string\[]}
The raw request/response headers list exactly as they were received.
@ -4099,7 +4099,7 @@ console.log(request.rawHeaders);
added: v8.4.0
-->
* {string\[]}
* Type: {string\[]}
The raw request/response trailer keys and values exactly as they were
received. Only populated at the `'end'` event.
@ -4110,7 +4110,7 @@ received. Only populated at the `'end'` event.
added: v8.4.0
-->
* {string}
* Type: {string}
The request scheme pseudo header field indicating the scheme
portion of the target URL.
@ -4140,7 +4140,7 @@ events, timed out sockets must be handled explicitly.
added: v8.4.0
-->
* {net.Socket|tls.TLSSocket}
* Type: {net.Socket|tls.TLSSocket}
Returns a `Proxy` object that acts as a `net.Socket` (or `tls.TLSSocket`) but
applies getters, setters, and methods based on HTTP/2 logic.
@ -4167,7 +4167,7 @@ authentication details.
added: v8.4.0
-->
* {Http2Stream}
* Type: {Http2Stream}
The [`Http2Stream`][] object backing the request.
@ -4177,7 +4177,7 @@ The [`Http2Stream`][] object backing the request.
added: v8.4.0
-->
* {Object}
* Type: {Object}
The request/response trailers object. Only populated at the `'end'` event.
@ -4187,7 +4187,7 @@ The request/response trailers object. Only populated at the `'end'` event.
added: v8.4.0
-->
* {string}
* Type: {string}
Request URL string. This contains only the URL that is present in the actual
HTTP request. If the request is:
@ -4314,7 +4314,7 @@ deprecated: v13.0.0
> Stability: 0 - Deprecated. Use [`response.socket`][].
* {net.Socket|tls.TLSSocket}
* Type: {net.Socket|tls.TLSSocket}
See [`response.socket`][].
@ -4380,7 +4380,7 @@ deprecated:
> Stability: 0 - Deprecated. Use [`response.writableEnded`][].
* {boolean}
* Type: {boolean}
Boolean value that indicates whether the response has completed. Starts
as `false`. After [`response.end()`][] executes, the value will be `true`.
@ -4469,7 +4469,7 @@ const hasContentType = response.hasHeader('content-type');
added: v8.4.0
-->
* {boolean}
* Type: {boolean}
True if headers were sent, false otherwise (read-only).
@ -4493,7 +4493,7 @@ response.removeHeader('Content-Encoding');
added: v15.7.0
-->
* {http2.Http2ServerRequest}
* Type: {http2.Http2ServerRequest}
A reference to the original HTTP2 `request` object.
@ -4503,7 +4503,7 @@ A reference to the original HTTP2 `request` object.
added: v8.4.0
-->
* {boolean}
* Type: {boolean}
When true, the Date header will be automatically generated and sent in
the response if it is not already present in the headers. Defaults to true.
@ -4576,7 +4576,7 @@ events, timed out sockets must be handled explicitly.
added: v8.4.0
-->
* {net.Socket|tls.TLSSocket}
* Type: {net.Socket|tls.TLSSocket}
Returns a `Proxy` object that acts as a `net.Socket` (or `tls.TLSSocket`) but
applies getters, setters, and methods based on HTTP/2 logic.
@ -4619,7 +4619,7 @@ const server = http2.createServer((req, res) => {
added: v8.4.0
-->
* {number}
* Type: {number}
When using implicit headers (not calling [`response.writeHead()`][] explicitly),
this property controls the status code that will be sent to the client when
@ -4638,7 +4638,7 @@ status code which was sent out.
added: v8.4.0
-->
* {string}
* Type: {string}
Status message is not supported by HTTP/2 (RFC 7540 8.1.2.4). It returns
an empty string.
@ -4649,7 +4649,7 @@ an empty string.
added: v8.4.0
-->
* {Http2Stream}
* Type: {Http2Stream}
The [`Http2Stream`][] object backing the response.
@ -4659,7 +4659,7 @@ The [`Http2Stream`][] object backing the response.
added: v12.9.0
-->
* {boolean}
* Type: {boolean}
Is `true` after [`response.end()`][] has been called. This property
does not indicate whether the data has been flushed, for this use

10
doc/api/https.md
View file

@ -168,7 +168,7 @@ See [`server.closeIdleConnections()`][] in the `node:http` module.
added: v11.3.0
-->
* {number} **Default:** `60000`
* Type: {number} **Default:** `60000`
See [`server.headersTimeout`][] in the `node:http` module.
@ -179,7 +179,7 @@ This method is identical to [`server.listen()`][] from [`net.Server`][].
### `server.maxHeadersCount`
* {number} **Default:** `2000`
* Type: {number} **Default:** `2000`
See [`server.maxHeadersCount`][] in the `node:http` module.
@ -194,7 +194,7 @@ changes:
from no timeout to 300s (5 minutes).
-->
* {number} **Default:** `300000`
* Type: {number} **Default:** `300000`
See [`server.requestTimeout`][] in the `node:http` module.
@ -220,7 +220,7 @@ changes:
description: The default timeout changed from 120s to 0 (no timeout).
-->
* {number} **Default:** 0 (no timeout)
* Type: {number} **Default:** 0 (no timeout)
See [`server.timeout`][] in the `node:http` module.
@ -230,7 +230,7 @@ See [`server.timeout`][] in the `node:http` module.
added: v8.0.0
-->
* {number} **Default:** `5000` (5 seconds)
* Type: {number} **Default:** `5000` (5 seconds)
See [`server.keepAliveTimeout`][] in the `node:http` module.

10
doc/api/inspector.md
View file

@ -64,7 +64,7 @@ command.
added: v8.0.0
-->
* {Object} The notification message object
* Type: {Object} The notification message object
Emitted when any notification from the V8 Inspector is received.
@ -85,7 +85,7 @@ It is also possible to subscribe only to notifications with specific method:
added: v8.0.0
-->
* {Object} The notification message object
* Type: {Object} The notification message object
Emitted when an inspector notification is received that has its method field set
to the `<inspector-protocol-method>` value.
@ -243,7 +243,7 @@ command.
added: v8.0.0
-->
* {Object} The notification message object
* Type: {Object} The notification message object
Emitted when any notification from the V8 Inspector is received.
@ -264,7 +264,7 @@ It is also possible to subscribe only to notifications with specific method:
added: v8.0.0
-->
* {Object} The notification message object
* Type: {Object} The notification message object
Emitted when an inspector notification is received that has its method field set
to the `<inspector-protocol-method>` value.
@ -420,7 +420,7 @@ are closed. Once all connections are closed, deactivates the inspector.
### `inspector.console`
* {Object} An object to send messages to the remote inspector console.
* Type: {Object} An object to send messages to the remote inspector console.
```js
require('node:inspector').console.log('a message');

18
doc/api/module.md
View file

@ -8,7 +8,7 @@ added: v0.3.7
## The `Module` object
* {Object}
* Type: {Object}
Provides general utility methods when interacting with instances of
`Module`, the [`module`][] variable often seen in [CommonJS][] modules. Accessed
@ -27,7 +27,7 @@ changes:
description: The list now also contains prefix-only modules.
-->
* {string\[]}
* Type: {string\[]}
A list of the names of all modules provided by Node.js. Can be used to verify
if a module is maintained by a third party or not.
@ -1691,13 +1691,13 @@ Creates a new `sourceMap` instance.
`payload` is an object with keys matching the [Source map format][]:
* `file`: {string}
* `version`: {number}
* `sources`: {string\[]}
* `sourcesContent`: {string\[]}
* `names`: {string\[]}
* `mappings`: {string}
* `sourceRoot`: {string}
* `file` {string}
* `version` {number}
* `sources` {string\[]}
* `sourcesContent` {string\[]}
* `names` {string\[]}
* `mappings` {string}
* `sourceRoot` {string}
`lineLengths` is an optional array of the length of each line in the
generated code.

32
doc/api/modules.md
View file

@ -775,7 +775,7 @@ added: v0.1.27
<!-- type=var -->
* {string}
* Type: {string}
The directory name of the current module. This is the same as the
[`path.dirname()`][] of the [`__filename`][].
@ -797,7 +797,7 @@ added: v0.0.1
<!-- type=var -->
* {string}
* Type: {string}
The file name of the current module. This is the current module file's absolute
path with symlinks resolved.
@ -836,7 +836,7 @@ added: v0.1.12
<!-- type=var -->
* {Object}
* Type: {Object}
A reference to the `module.exports` that is shorter to type.
See the section about the [exports shortcut][] for details on when to use
@ -850,7 +850,7 @@ added: v0.1.16
<!-- type=var -->
* {module}
* Type: {module}
A reference to the current module, see the section about the
[`module` object][]. In particular, `module.exports` is used for defining what
@ -893,7 +893,7 @@ const crypto = require('node:crypto');
added: v0.3.0
-->
* {Object}
* Type: {Object}
Modules are cached in this object when they are required. By deleting a key
value from this object, the next `require` will reload the module.
@ -927,7 +927,7 @@ deprecated: v0.10.6
> Stability: 0 - Deprecated
* {Object}
* Type: {Object}
Instruct `require` on how to handle certain file extensions.
@ -951,7 +951,7 @@ extensions gets slower with each registered extension.
added: v0.1.17
-->
* {module | undefined}
* Type: {module | undefined}
The `Module` object representing the entry script loaded when the Node.js
process launched, or `undefined` if the entry point of the program is not a
@ -1033,7 +1033,7 @@ added: v0.1.16
<!-- name=module -->
* {Object}
* Type: {Object}
In each module, the `module` free variable is a reference to the object
representing the current module. For convenience, `module.exports` is
@ -1046,7 +1046,7 @@ a global but rather local to each module.
added: v0.1.16
-->
* {module\[]}
* Type: {module\[]}
The module objects required for the first time by this one.
@ -1056,7 +1056,7 @@ The module objects required for the first time by this one.
added: v0.1.16
-->
* {Object}
* Type: {Object}
The `module.exports` object is created by the `Module` system. Sometimes this is
not acceptable; many want their module to be an instance of some class. To do
@ -1160,7 +1160,7 @@ function require(/* ... */) {
added: v0.1.16
-->
* {string}
* Type: {string}
The fully resolved filename of the module.
@ -1170,7 +1170,7 @@ The fully resolved filename of the module.
added: v0.1.16
-->
* {string}
* Type: {string}
The identifier for the module. Typically this is the fully resolved
filename.
@ -1192,7 +1192,7 @@ added:
added: v0.1.16
-->
* {boolean}
* Type: {boolean}
Whether or not the module is done loading, or is in the process of
loading.
@ -1209,7 +1209,7 @@ deprecated:
> Stability: 0 - Deprecated: Please use [`require.main`][] and
> [`module.children`][] instead.
* {module | null | undefined}
* Type: {module | null | undefined}
The module that first required this one, or `null` if the current module is the
entry point of the current process, or `undefined` if the module was loaded by
@ -1221,7 +1221,7 @@ something that is not a CommonJS module (E.G.: REPL or `import`).
added: v11.14.0
-->
* {string}
* Type: {string}
The directory name of the module. This is usually the same as the
[`path.dirname()`][] of the [`module.id`][].
@ -1232,7 +1232,7 @@ The directory name of the module. This is usually the same as the
added: v0.4.0
-->
* {string\[]}
* Type: {string\[]}
The search paths for the module.

52
doc/api/net.md
View file

@ -246,7 +246,7 @@ added:
- v14.18.0
-->
* Type {string}
* Type: {string}
### `socketaddress.family`
@ -256,7 +256,7 @@ added:
- v14.18.0
-->
* Type {string} Either `'ipv4'` or `'ipv6'`.
* Type: {string} Either `'ipv4'` or `'ipv6'`.
### `socketaddress.flowlabel`
@ -266,7 +266,7 @@ added:
- v14.18.0
-->
* Type {number}
* Type: {number}
### `socketaddress.port`
@ -276,7 +276,7 @@ added:
- v14.18.0
-->
* Type {number}
* Type: {number}
### `SocketAddress.parse(input)`
@ -326,7 +326,7 @@ event is not emitted until all connections are ended.
added: v0.1.90
-->
* {net.Socket} The connection object
* Type: {net.Socket} The connection object
Emitted when a new connection is made. `socket` is an instance of
`net.Socket`.
@ -337,7 +337,7 @@ Emitted when a new connection is made. `socket` is an instance of
added: v0.1.90
-->
* {Error}
* Type: {Error}
Emitted when an error occurs. Unlike [`net.Socket`][], the [`'close'`][]
event will **not** be emitted directly following this event unless
@ -656,7 +656,7 @@ may cause the `net.Server` to also listen on the [unspecified IPv4 address][]
added: v5.7.0
-->
* {boolean} Indicates whether or not the server is listening for connections.
* Type: {boolean} Indicates whether or not the server is listening for connections.
### `server.maxConnections`
@ -669,7 +669,7 @@ changes:
connections. Previously, it was interpreted as `Infinity`.
-->
* {integer}
* Type: {integer}
When the number of connections reaches the `server.maxConnections` threshold:
@ -688,7 +688,7 @@ added:
- v22.12.0
-->
* {boolean}
* Type: {boolean}
Set this property to `true` to begin closing connections once the number of connections reaches the \[`server.maxConnections`]\[] threshold. This setting is only effective in cluster mode.
@ -856,7 +856,7 @@ in [`socket.connect(options)`][].
added: v0.1.90
-->
* {Buffer|string}
* Type: {Buffer|string}
Emitted when data is received. The argument `data` will be a `Buffer` or
`String`. Encoding of data is set by [`socket.setEncoding()`][].
@ -897,7 +897,7 @@ FIN packet back).
added: v0.1.90
-->
* {Error}
* Type: {Error}
Emitted when an error occurs. The `'close'` event will be called directly
following this event.
@ -968,7 +968,7 @@ added:
- v18.18.0
-->
* {string\[]}
* Type: {string\[]}
This property is only present if the family autoselection algorithm is enabled in
[`socket.connect(options)`][] and it is an array of the addresses that have been attempted.
@ -986,7 +986,7 @@ deprecated:
> Stability: 0 - Deprecated: Use [`writable.writableLength`][] instead.
* {integer}
* Type: {integer}
This property shows the number of characters buffered for writing. The buffer
may contain strings whose length after encoding is not yet known. So this number
@ -1009,7 +1009,7 @@ Users who experience large or growing `bufferSize` should attempt to
added: v0.5.3
-->
* {integer}
* Type: {integer}
The amount of received bytes.
@ -1019,7 +1019,7 @@ The amount of received bytes.
added: v0.5.3
-->
* {integer}
* Type: {integer}
The amount of bytes sent.
@ -1178,7 +1178,7 @@ called with `{port: port, host: host}` as `options`.
added: v6.1.0
-->
* {boolean}
* Type: {boolean}
If `true`,
[`socket.connect(options[, connectListener])`][`socket.connect(options)`] was
@ -1204,7 +1204,7 @@ See [`writable.destroy()`][] for further details.
### `socket.destroyed`
* {boolean} Indicates if the connection is destroyed or not. Once a
* Type: {boolean} Indicates if the connection is destroyed or not. Once a
connection is destroyed no further data can be transferred using it.
See [`writable.destroyed`][] for further details.
@ -1241,7 +1241,7 @@ See [`writable.end()`][] for further details.
added: v0.9.6
-->
* {string}
* Type: {string}
The string representation of the local IP address the remote client is
connecting on. For example, in a server listening on `'0.0.0.0'`, if a client
@ -1254,7 +1254,7 @@ connects on `'192.168.1.1'`, the value of `socket.localAddress` would be
added: v0.9.6
-->
* {integer}
* Type: {integer}
The numeric representation of the local port. For example, `80` or `21`.
@ -1266,7 +1266,7 @@ added:
- v16.18.0
-->
* {string}
* Type: {string}
The string representation of the local IP family. `'IPv4'` or `'IPv6'`.
@ -1285,7 +1285,7 @@ added:
- v10.16.0
-->
* {boolean}
* Type: {boolean}
This is `true` if the socket is not connected yet, either because `.connect()`
has not yet been called or because it is still in the process of connecting
@ -1309,7 +1309,7 @@ If the socket is `ref`ed calling `ref` again will have no effect.
added: v0.5.10
-->
* {string}
* Type: {string}
The string representation of the remote IP address. For example,
`'74.125.127.100'` or `'2001:4860:a005::68'`. Value may be `undefined` if
@ -1321,7 +1321,7 @@ the socket is destroyed (for example, if the client disconnected).
added: v0.11.14
-->
* {string}
* Type: {string}
The string representation of the remote IP family. `'IPv4'` or `'IPv6'`. Value may be `undefined` if
the socket is destroyed (for example, if the client disconnected).
@ -1332,7 +1332,7 @@ the socket is destroyed (for example, if the client disconnected).
added: v0.5.10
-->
* {integer}
* Type: {integer}
The numeric representation of the remote port. For example, `80` or `21`. Value may be `undefined` if
the socket is destroyed (for example, if the client disconnected).
@ -1463,7 +1463,7 @@ The optional `callback` parameter will be added as a one-time listener for the
added: v10.7.0
-->
* {number|undefined}
* Type: {number|undefined}
The socket timeout in milliseconds as set by [`socket.setTimeout()`][].
It is `undefined` if a timeout has not been set.
@ -1510,7 +1510,7 @@ information.
added: v0.5.0
-->
* {string}
* Type: {string}
This property represents the state of the connection as a string.

6
doc/api/os.md
View file

@ -23,7 +23,7 @@ const os = require('node:os');
added: v0.7.8
-->
* {string}
* Type: {string}
The operating system-specific end-of-line marker.
@ -65,7 +65,7 @@ The return value is equivalent to [`process.arch`][].
added: v6.3.0
-->
* {Object}
* Type: {Object}
Contains commonly used operating system-specific constants for error codes,
process signals, and so on. The specific constants defined are described in
@ -160,7 +160,7 @@ added:
- v14.18.0
-->
* {string}
* Type: {string}
The platform-specific file path of the null device.

2
doc/api/packages.md
View file

@ -1092,7 +1092,7 @@ changes:
description: Implement conditional exports.
-->
* Type: {Object} | {string} | {string\[]}
* Type: {Object|string|string\[]}
```json
{

8
doc/api/path.md
View file

@ -114,7 +114,7 @@ and is not a string.
added: v0.9.3
-->
* {string}
* Type: {string}
Provides the platform-specific path delimiter:
@ -501,7 +501,7 @@ changes:
description: Exposed as `require('path/posix')`.
-->
* {Object}
* Type: {Object}
The `path.posix` property provides access to POSIX specific implementations
of the `path` methods.
@ -595,7 +595,7 @@ A [`TypeError`][] is thrown if any of the arguments is not a string.
added: v0.7.9
-->
* {string}
* Type: {string}
Provides the platform-specific path segment separator:
@ -646,7 +646,7 @@ changes:
description: Exposed as `require('path/win32')`.
-->
* {Object}
* Type: {Object}
The `path.win32` property provides access to Windows-specific implementations
of the `path` methods.

90
doc/api/perf_hooks.md
View file

@ -369,7 +369,7 @@ Performance Timeline manually with `performance.clearMeasures`.
added: v8.5.0
-->
* {PerformanceNodeTiming}
* Type: {PerformanceNodeTiming}
_This property is an extension by Node.js. It is not available in Web browsers._
@ -414,7 +414,7 @@ By default the max buffer size is set to 250.
added: v8.5.0
-->
* {number}
* Type: {number}
The [`timeOrigin`][] specifies the high resolution millisecond timestamp at
which the current `node` process began, measured in Unix time.
@ -541,7 +541,7 @@ changes:
`PerformanceEntry` object as the receiver.
-->
* {number}
* Type: {number}
The total number of milliseconds elapsed for this entry. This value will not
be meaningful for all Performance Entry types.
@ -557,7 +557,7 @@ changes:
`PerformanceEntry` object as the receiver.
-->
* {string}
* Type: {string}
The type of the performance entry. It may be one of:
@ -583,7 +583,7 @@ changes:
`PerformanceEntry` object as the receiver.
-->
* {string}
* Type: {string}
The name of the performance entry.
@ -598,7 +598,7 @@ changes:
`PerformanceEntry` object as the receiver.
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp marking the starting time of the
Performance Entry.
@ -626,7 +626,7 @@ changes:
`PerformanceMark` object as the receiver.
-->
* {any}
* Type: {any}
Additional detail specified when creating with `Performance.mark()` method.
@ -655,7 +655,7 @@ changes:
`PerformanceMeasure` object as the receiver.
-->
* {any}
* Type: {any}
Additional detail specified when creating with `Performance.measure()` method.
@ -684,7 +684,7 @@ changes:
`PerformanceNodeEntry` object as the receiver.
-->
* {any}
* Type: {any}
Additional detail specific to the `entryType`.
@ -703,7 +703,7 @@ changes:
> Stability: 0 - Deprecated: Use `performanceNodeEntry.detail` instead.
* {number}
* Type: {number}
When `performanceEntry.entryType` is equal to `'gc'`, the `performance.flags`
property contains additional information about garbage collection operation.
@ -730,7 +730,7 @@ changes:
> Stability: 0 - Deprecated: Use `performanceNodeEntry.detail` instead.
* {number}
* Type: {number}
When `performanceEntry.entryType` is equal to `'gc'`, the `performance.kind`
property identifies the type of garbage collection operation that occurred.
@ -871,7 +871,7 @@ is not exposed to users.
added: v8.5.0
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp at which the Node.js process
completed bootstrapping. If bootstrapping has not yet finished, the property
@ -883,7 +883,7 @@ has the value of -1.
added: v8.5.0
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp at which the Node.js environment was
initialized.
@ -896,7 +896,7 @@ added:
- v12.19.0
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp of the amount of time the event loop
has been idle within the event loop's event provider (e.g. `epoll_wait`). This
@ -910,7 +910,7 @@ value of 0.
added: v8.5.0
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp at which the Node.js event loop
exited. If the event loop has not yet exited, the property has the value of -1.
@ -922,7 +922,7 @@ It can only have a value of not -1 in a handler of the [`'exit'`][] event.
added: v8.5.0
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp at which the Node.js event loop
started. If the event loop has not yet started (e.g., in the first tick of the
@ -934,7 +934,7 @@ main script), the property has the value of -1.
added: v8.5.0
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp at which the Node.js process was
initialized.
@ -981,7 +981,7 @@ setImmediate(() => {
added: v8.5.0
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp at which the V8 platform was
initialized.
@ -1014,7 +1014,7 @@ changes:
`PerformanceResourceTiming` object as the receiver.
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp at immediately before dispatching
the `fetch` request. If the resource is not intercepted by a worker the property
@ -1033,7 +1033,7 @@ changes:
`PerformanceResourceTiming` object as the receiver.
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp that represents the start time
of the fetch which initiates the redirect.
@ -1051,7 +1051,7 @@ changes:
`PerformanceResourceTiming` object as the receiver.
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp that will be created immediately after
receiving the last byte of the response of the last redirect.
@ -1069,7 +1069,7 @@ changes:
`PerformanceResourceTiming` object as the receiver.
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp immediately before the Node.js starts
to fetch the resource.
@ -1087,7 +1087,7 @@ changes:
`PerformanceResourceTiming` object as the receiver.
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp immediately before the Node.js starts
the domain name lookup for the resource.
@ -1105,7 +1105,7 @@ changes:
`PerformanceResourceTiming` object as the receiver.
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp representing the time immediately
after the Node.js finished the domain name lookup for the resource.
@ -1123,7 +1123,7 @@ changes:
`PerformanceResourceTiming` object as the receiver.
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp representing the time immediately
before Node.js starts to establish the connection to the server to retrieve
@ -1142,7 +1142,7 @@ changes:
`PerformanceResourceTiming` object as the receiver.
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp representing the time immediately
after Node.js finishes establishing the connection to the server to retrieve
@ -1161,7 +1161,7 @@ changes:
`PerformanceResourceTiming` object as the receiver.
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp representing the time immediately
before Node.js starts the handshake process to secure the current connection.
@ -1179,7 +1179,7 @@ changes:
`PerformanceResourceTiming` object as the receiver.
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp representing the time immediately
before Node.js receives the first byte of the response from the server.
@ -1197,7 +1197,7 @@ changes:
`PerformanceResourceTiming` object as the receiver.
-->
* {number}
* Type: {number}
The high resolution millisecond timestamp representing the time immediately
after Node.js receives the last byte of the resource or immediately before
@ -1216,7 +1216,7 @@ changes:
`PerformanceResourceTiming` object as the receiver.
-->
* {number}
* Type: {number}
A number representing the size (in octets) of the fetched resource. The size
includes the response header fields plus the response payload body.
@ -1234,7 +1234,7 @@ changes:
`PerformanceResourceTiming` object as the receiver.
-->
* {number}
* Type: {number}
A number representing the size (in octets) received from the fetch
(HTTP or cache), of the payload body, before removing any applied
@ -1253,7 +1253,7 @@ changes:
`PerformanceResourceTiming` object as the receiver.
-->
* {number}
* Type: {number}
A number representing the size (in octets) received from the fetch
(HTTP or cache), of the message body, after removing any applied
@ -1287,7 +1287,7 @@ added: v8.5.0
added: v16.0.0
-->
* {string\[]}
* Type: {string\[]}
Get supported types.
@ -1789,7 +1789,7 @@ added:
- v16.14.0
-->
* {number}
* Type: {number}
The number of samples recorded by the histogram.
@ -1801,7 +1801,7 @@ added:
- v16.14.0
-->
* {bigint}
* Type: {bigint}
The number of samples recorded by the histogram.
@ -1811,7 +1811,7 @@ The number of samples recorded by the histogram.
added: v11.10.0
-->
* {number}
* Type: {number}
The number of times the event loop delay exceeded the maximum 1 hour event
loop delay threshold.
@ -1824,7 +1824,7 @@ added:
- v16.14.0
-->
* {bigint}
* Type: {bigint}
The number of times the event loop delay exceeded the maximum 1 hour event
loop delay threshold.
@ -1835,7 +1835,7 @@ loop delay threshold.
added: v11.10.0
-->
* {number}
* Type: {number}
The maximum recorded event loop delay.
@ -1847,7 +1847,7 @@ added:
- v16.14.0
-->
* {bigint}
* Type: {bigint}
The maximum recorded event loop delay.
@ -1857,7 +1857,7 @@ The maximum recorded event loop delay.
added: v11.10.0
-->
* {number}
* Type: {number}
The mean of the recorded event loop delays.
@ -1867,7 +1867,7 @@ The mean of the recorded event loop delays.
added: v11.10.0
-->
* {number}
* Type: {number}
The minimum recorded event loop delay.
@ -1879,7 +1879,7 @@ added:
- v16.14.0
-->
* {bigint}
* Type: {bigint}
The minimum recorded event loop delay.
@ -1913,7 +1913,7 @@ Returns the value at the given percentile.
added: v11.10.0
-->
* {Map}
* Type: {Map}
Returns a `Map` object detailing the accumulated percentile distribution.
@ -1925,7 +1925,7 @@ added:
- v16.14.0
-->
* {Map}
* Type: {Map}
Returns a `Map` object detailing the accumulated percentile distribution.
@ -1943,7 +1943,7 @@ Resets the collected histogram data.
added: v11.10.0
-->
* {number}
* Type: {number}
The standard deviation of the recorded event loop delays.

106
doc/api/process.md
View file

@ -742,7 +742,7 @@ This feature is not available in [`Worker`][] threads.
added: v10.10.0
-->
* {Set}
* Type: {Set}
The `process.allowedNodeEnvironmentFlags` property is a special,
read-only `Set` of flags allowable within the [`NODE_OPTIONS`][]
@ -805,7 +805,7 @@ contain what _would have_ been allowable.
added: v0.5.0
-->
* {string}
* Type: {string}
The operating system CPU architecture for which the Node.js binary was compiled.
Possible values are: `'arm'`, `'arm64'`, `'ia32'`, `'loong64'`, `'mips'`,
@ -829,7 +829,7 @@ console.log(`This processor architecture is ${arch}`);
added: v0.1.27
-->
* {string\[]}
* Type: {string\[]}
The `process.argv` property returns an array containing the command-line
arguments passed when the Node.js process was launched. The first element will
@ -880,7 +880,7 @@ Would generate the output:
added: v6.4.0
-->
* {string}
* Type: {string}
The `process.argv0` property stores a read-only copy of the original value of
`argv[0]` passed when Node.js starts.
@ -907,7 +907,7 @@ changes:
description: Change stability index for this feature from Experimental to Stable.
-->
* {number}
* Type: {number}
Gets the amount of free memory that is still available to the process
(in bytes).
@ -925,7 +925,7 @@ changes:
description: The object no longer accidentally exposes native C++ bindings.
-->
* {Object}
* Type: {Object}
If the Node.js process was spawned with an IPC channel (see the
[Child Process][] documentation), the `process.channel`
@ -1009,7 +1009,7 @@ changes:
description: Modifying process.config has been deprecated.
-->
* {Object}
* Type: {Object}
The `process.config` property returns a frozen `Object` containing the
JavaScript representation of the configure options used to compile the current
@ -1052,7 +1052,7 @@ An example of the possible output looks like:
added: v0.7.2
-->
* {boolean}
* Type: {boolean}
If the Node.js process is spawned with an IPC channel (see the [Child Process][]
and [Cluster][] documentation), the `process.connected` property will return
@ -1081,7 +1081,7 @@ changes:
description: Aligned return value with `uv_get_constrained_memory`.
-->
* {number}
* Type: {number}
Gets the amount of memory available to the process (in bytes) based on
limits imposed by the OS. If there is no such constraint, or the constraint
@ -1168,7 +1168,7 @@ console.log(`Current directory: ${cwd()}`);
added: v0.7.2
-->
* {number}
* Type: {number}
The port used by the Node.js debugger when enabled.
@ -1516,7 +1516,7 @@ changes:
description: Implicit conversion of variable value to string is deprecated.
-->
* {Object}
* Type: {Object}
The `process.env` property returns an object containing the user environment.
See environ(7).
@ -1644,7 +1644,7 @@ unlike the main thread.
added: v0.7.7
-->
* {string\[]}
* Type: {string\[]}
The `process.execArgv` property returns the set of Node.js-specific command-line
options passed when the Node.js process was launched. These options do not
@ -1680,7 +1680,7 @@ threads with this property.
added: v0.1.100
-->
* {string}
* Type: {string}
The `process.execPath` property returns the absolute pathname of the executable
that started the Node.js process. Symbolic links, if any, are resolved.
@ -1839,7 +1839,7 @@ changes:
represents an integer.
-->
* {integer|string|null|undefined} The exit code. For string type, only
* Type: {integer|string|null|undefined} The exit code. For string type, only
integer strings (e.g.,'1') are allowed. **Default:** `undefined`.
A number which will be the process exit code, when the process either
@ -1875,7 +1875,7 @@ $ node --input-type=module -e 'process.exitCode = 9; await new Promise(() => {})
added: v12.0.0
-->
* {boolean}
* Type: {boolean}
A boolean value that is `true` if the current Node.js build is caching builtin modules.
@ -1885,7 +1885,7 @@ A boolean value that is `true` if the current Node.js build is caching builtin m
added: v0.5.5
-->
* {boolean}
* Type: {boolean}
A boolean value that is `true` if the current Node.js build is a debug build.
@ -1895,7 +1895,7 @@ A boolean value that is `true` if the current Node.js build is a debug build.
added: v11.10.0
-->
* {boolean}
* Type: {boolean}
A boolean value that is `true` if the current Node.js build includes the inspector.
@ -1911,7 +1911,7 @@ deprecated:
> Stability: 0 - Deprecated. This property is always true, and any checks based on it are
> redundant.
* {boolean}
* Type: {boolean}
A boolean value that is `true` if the current Node.js build includes support for IPv6.
@ -1926,7 +1926,7 @@ added:
- v20.19.0
-->
* {boolean}
* Type: {boolean}
A boolean value that is `true` if the current Node.js build supports
[loading ECMAScript modules using `require()`][].
@ -1937,7 +1937,7 @@ A boolean value that is `true` if the current Node.js build supports
added: v0.5.3
-->
* {boolean}
* Type: {boolean}
A boolean value that is `true` if the current Node.js build includes support for TLS.
@ -1952,7 +1952,7 @@ deprecated:
> Stability: 0 - Deprecated. Use `process.features.tls` instead.
* {boolean}
* Type: {boolean}
A boolean value that is `true` if the current Node.js build includes support for ALPN in TLS.
@ -1970,7 +1970,7 @@ deprecated:
> Stability: 0 - Deprecated. Use `process.features.tls` instead.
* {boolean}
* Type: {boolean}
A boolean value that is `true` if the current Node.js build includes support for OCSP in TLS.
@ -1988,7 +1988,7 @@ deprecated:
> Stability: 0 - Deprecated. Use `process.features.tls` instead.
* {boolean}
* Type: {boolean}
A boolean value that is `true` if the current Node.js build includes support for SNI in TLS.
@ -2005,7 +2005,7 @@ added:
> Stability: 1.2 - Release candidate
* {boolean|string}
* Type: {boolean|string}
A value that is `"strip"` by default,
`"transform"` if Node.js is run with `--experimental-transform-types`, and `false` if
@ -2023,7 +2023,7 @@ deprecated:
> Stability: 0 - Deprecated. This property is always true, and any checks based on it are
> redundant.
* {boolean}
* Type: {boolean}
A boolean value that is `true` if the current Node.js build includes support for libuv.
@ -2724,7 +2724,7 @@ deprecated: v14.0.0
> Stability: 0 - Deprecated: Use [`require.main`][] instead.
* {Object}
* Type: {Object}
The `process.mainModule` property provides an alternative way of retrieving
[`require.main`][]. The difference is that if the main module changes at
@ -3085,7 +3085,7 @@ needed, use `queueMicrotask()`.
added: v0.8.0
-->
* {boolean}
* Type: {boolean}
The `process.noDeprecation` property indicates whether the `--no-deprecation`
flag is set on the current Node.js process. See the documentation for
@ -3099,7 +3099,7 @@ flag's behavior.
added: v20.0.0
-->
* {Object}
* Type: {Object}
This API is available through the [`--permission`][] flag.
@ -3146,7 +3146,7 @@ process.permission.has('fs.read');
added: v0.1.15
-->
* {integer}
* Type: {integer}
The `process.pid` property returns the PID of the process.
@ -3168,7 +3168,7 @@ console.log(`This process is pid ${pid}`);
added: v0.1.16
-->
* {string}
* Type: {string}
The `process.platform` property returns a string identifying the operating
system platform for which the Node.js binary was compiled.
@ -3208,7 +3208,7 @@ added:
- v6.13.0
-->
* {integer}
* Type: {integer}
The `process.ppid` property returns the PID of the parent of the
current process.
@ -3256,7 +3256,7 @@ changes:
description: The `lts` property is now supported.
-->
* {Object}
* Type: {Object}
The `process.release` property returns an `Object` containing metadata related
to the current release, including URLs for the source tarball and headers-only
@ -3312,7 +3312,7 @@ changes:
description: This API is no longer experimental.
-->
* {Object}
* Type: {Object}
`process.report` is an object whose methods are used to generate diagnostic
reports for the current process. Additional documentation is available in the
@ -3326,7 +3326,7 @@ added:
- v12.17.0
-->
* {boolean}
* Type: {boolean}
Write reports in a compact format, single-line JSON, more easily consumable
by log processing systems than the default multi-line format designed for
@ -3356,7 +3356,7 @@ changes:
description: This API is no longer experimental.
-->
* {string}
* Type: {string}
Directory where the report is written. The default value is the empty string,
indicating that reports are written to the current working directory of the
@ -3386,7 +3386,7 @@ changes:
description: This API is no longer experimental.
-->
* {string}
* Type: {string}
Filename where the report is written. If set to the empty string, the output
filename will be comprised of a timestamp, PID, and sequence number. The default
@ -3464,7 +3464,7 @@ changes:
description: This API is no longer experimental.
-->
* {boolean}
* Type: {boolean}
If `true`, a diagnostic report is generated on fatal errors, such as out of
memory errors or failed C++ assertions.
@ -3493,7 +3493,7 @@ changes:
description: This API is no longer experimental.
-->
* {boolean}
* Type: {boolean}
If `true`, a diagnostic report is generated when the process receives the
signal specified by `process.report.signal`.
@ -3522,7 +3522,7 @@ changes:
description: This API is no longer experimental.
-->
* {boolean}
* Type: {boolean}
If `true`, a diagnostic report is generated on uncaught exception.
@ -3546,7 +3546,7 @@ added:
- v22.13.0
-->
* {boolean}
* Type: {boolean}
If `true`, a diagnostic report is generated without the environment variables.
@ -3562,7 +3562,7 @@ changes:
description: This API is no longer experimental.
-->
* {string}
* Type: {string}
The signal used to trigger the creation of a diagnostic report. Defaults to
`'SIGUSR2'`.
@ -4034,14 +4034,14 @@ added:
> Stability: 1 - Experimental: Use [`module.getSourceMapsSupport()`][] instead.
* {boolean}
* Type: {boolean}
The `process.sourceMapsEnabled` property returns whether the
[Source Map][] support for stack traces is enabled.
## `process.stderr`
* {Stream}
* Type: {Stream}
The `process.stderr` property returns a stream connected to
`stderr` (fd `2`). It is a [`net.Socket`][] (which is a [Duplex][]
@ -4053,7 +4053,7 @@ a [Writable][] stream.
### `process.stderr.fd`
* {number}
* Type: {number}
This property refers to the value of underlying file descriptor of
`process.stderr`. The value is fixed at `2`. In [`Worker`][] threads,
@ -4061,7 +4061,7 @@ this field does not exist.
## `process.stdin`
* {Stream}
* Type: {Stream}
The `process.stdin` property returns a stream connected to
`stdin` (fd `0`). It is a [`net.Socket`][] (which is a [Duplex][]
@ -4080,7 +4080,7 @@ must call `process.stdin.resume()` to read from it. Note also that calling
### `process.stdin.fd`
* {number}
* Type: {number}
This property refers to the value of underlying file descriptor of
`process.stdin`. The value is fixed at `0`. In [`Worker`][] threads,
@ -4088,7 +4088,7 @@ this field does not exist.
## `process.stdout`
* {Stream}
* Type: {Stream}
The `process.stdout` property returns a stream connected to
`stdout` (fd `1`). It is a [`net.Socket`][] (which is a [Duplex][]
@ -4114,7 +4114,7 @@ stdin.pipe(stdout);
### `process.stdout.fd`
* {number}
* Type: {number}
This property refers to the value of underlying file descriptor of
`process.stdout`. The value is fixed at `1`. In [`Worker`][] threads,
@ -4174,7 +4174,7 @@ See the [TTY][] documentation for more information.
added: v0.9.12
-->
* {boolean}
* Type: {boolean}
The initial value of `process.throwDeprecation` indicates whether the
`--throw-deprecation` flag is set on the current Node.js process.
@ -4224,7 +4224,7 @@ argument to the function, to get a diff reading.
added: v0.1.104
-->
* {string}
* Type: {string}
The `process.title` property returns the current process title (i.e. returns
the current value of `ps`). Assigning a new value to `process.title` modifies
@ -4249,7 +4249,7 @@ Services Manager.
added: v0.8.0
-->
* {boolean}
* Type: {boolean}
The `process.traceDeprecation` property indicates whether the
`--trace-deprecation` flag is set on the current Node.js process. See the
@ -4351,7 +4351,7 @@ seconds.
added: v0.1.3
-->
* {string}
* Type: {string}
The `process.version` property contains the Node.js version string.
@ -4385,7 +4385,7 @@ changes:
description: The `icu` property is now supported.
-->
* {Object}
* Type: {Object}
The `process.versions` property returns an object listing the version strings of
Node.js and its dependencies. `process.versions.modules` indicates the current

2
doc/api/punycode.md
View file

@ -155,7 +155,7 @@ punycode.ucs2.encode([0x1D306]); // '\uD834\uDF06'
added: v0.6.1
-->
* {string}
* Type: {string}
Returns a string identifying the current [Punycode.js][] version number.

256
doc/api/quic.md
View file

File diff suppressed because it is too large Load diff

4
doc/api/readline.md
View file

@ -437,7 +437,7 @@ changes:
description: Value will always be a string, never undefined.
-->
* {string}
* Type: {string}
The current input data being processed by node.
@ -473,7 +473,7 @@ process.stdin.on('keypress', (c, k) => {
added: v0.1.98
-->
* {number|undefined}
* Type: {number|undefined}
The cursor position relative to `rl.line`.

2
doc/api/repl.md
View file

@ -694,7 +694,7 @@ deprecated:
> Stability: 0 - Deprecated. Use [`module.builtinModules`][] instead.
* {string\[]}
* Type: {string\[]}
A list of the names of some Node.js modules, e.g., `'http'`.

24
doc/api/sqlite.md
View file

@ -324,7 +324,7 @@ added:
- v22.15.0
-->
* {boolean} Whether the database is currently open or not.
* Type: {boolean} Whether the database is currently open or not.
### `database.isTransaction`
@ -334,7 +334,7 @@ added:
- v22.16.0
-->
* {boolean} Whether the database is currently within a transaction. This method
* Type: {boolean} Whether the database is currently within a transaction. This method
is a wrapper around [`sqlite3_get_autocommit()`][].
### `database.open()`
@ -538,19 +538,19 @@ added:
* Returns: {Array} An array of objects. Each object corresponds to a column
in the prepared statement, and contains the following properties:
* `column`: {string|null} The unaliased name of the column in the origin
* `column` {string|null} The unaliased name of the column in the origin
table, or `null` if the column is the result of an expression or subquery.
This property is the result of [`sqlite3_column_origin_name()`][].
* `database`: {string|null} The unaliased name of the origin database, or
* `database` {string|null} The unaliased name of the origin database, or
`null` if the column is the result of an expression or subquery. This
property is the result of [`sqlite3_column_database_name()`][].
* `name`: {string} The name assigned to the column in the result set of a
* `name` {string} The name assigned to the column in the result set of a
`SELECT` statement. This property is the result of
[`sqlite3_column_name()`][].
* `table`: {string|null} The unaliased name of the origin table, or `null` if
* `table` {string|null} The unaliased name of the origin table, or `null` if
the column is the result of an expression or subquery. This property is the
result of [`sqlite3_column_table_name()`][].
* `type`: {string|null} The declared data type of the column, or `null` if the
* `type` {string|null} The declared data type of the column, or `null` if the
column is the result of an expression or subquery. This property is the
result of [`sqlite3_column_decltype()`][].
@ -563,7 +563,7 @@ prepared statement.
added: v22.5.0
-->
* {string} The source SQL expanded to include parameter values.
* Type: {string} The source SQL expanded to include parameter values.
The source SQL text of the prepared statement with parameter
placeholders replaced by the values that were used during the most recent
@ -640,12 +640,12 @@ changes:
* `...anonymousParameters` {null|number|bigint|string|Buffer|TypedArray|DataView} Zero or
more values to bind to anonymous parameters.
* Returns: {Object}
* `changes`: {number|bigint} The number of rows modified, inserted, or deleted
* `changes` {number|bigint} The number of rows modified, inserted, or deleted
by the most recently completed `INSERT`, `UPDATE`, or `DELETE` statement.
This field is either a number or a `BigInt` depending on the prepared
statement's configuration. This property is the result of
[`sqlite3_changes64()`][].
* `lastInsertRowid`: {number|bigint} The most recently inserted rowid. This
* `lastInsertRowid` {number|bigint} The most recently inserted rowid. This
field is either a number or a `BigInt` depending on the prepared statement's
configuration. This property is the result of
[`sqlite3_last_insert_rowid()`][].
@ -714,7 +714,7 @@ supported at all times.
added: v22.5.0
-->
* {string} The source SQL used to create this prepared statement.
* Type: {string} The source SQL used to create this prepared statement.
The source SQL text of the prepared statement. This property is a
wrapper around [`sqlite3_sql()`][].
@ -806,7 +806,7 @@ added:
- v22.13.0
-->
* {Object}
* Type: {Object}
An object containing commonly used constants for SQLite operations.

54
doc/api/stream.md
View file

@ -568,7 +568,7 @@ function writeOneMillionTimes(writer, data, encoding, callback) {
added: v0.9.4
-->
* {Error}
* Type: {Error}
The `'error'` event is emitted if an error occurred while writing or piping
data. The listener callback is passed a single `Error` argument when called.
@ -732,7 +732,7 @@ but instead implement [`writable._destroy()`][writable-_destroy].
added: v18.0.0
-->
* {boolean}
* Type: {boolean}
Is `true` after `'close'` has been emitted.
@ -742,7 +742,7 @@ Is `true` after `'close'` has been emitted.
added: v8.0.0
-->
* {boolean}
* Type: {boolean}
Is `true` after [`writable.destroy()`][writable-destroy] has been called.
@ -866,7 +866,7 @@ See also: [`writable.cork()`][].
added: v11.4.0
-->
* {boolean}
* Type: {boolean}
Is `true` if it is safe to call [`writable.write()`][stream-write], which means
the stream has not been destroyed, errored, or ended.
@ -885,7 +885,7 @@ changes:
description: Marking the API stable.
-->
* {boolean}
* Type: {boolean}
Returns whether the stream was destroyed or errored before emitting `'finish'`.
@ -895,7 +895,7 @@ Returns whether the stream was destroyed or errored before emitting `'finish'`.
added: v12.9.0
-->
* {boolean}
* Type: {boolean}
Is `true` after [`writable.end()`][] has been called. This property
does not indicate whether the data has been flushed, for this use
@ -909,7 +909,7 @@ added:
- v12.16.0
-->
* {integer}
* Type: {integer}
Number of times [`writable.uncork()`][stream-uncork] needs to be
called in order to fully uncork the stream.
@ -921,7 +921,7 @@ added:
v18.0.0
-->
* {Error}
* Type: {Error}
Returns error if the stream has been destroyed with an error.
@ -931,7 +931,7 @@ Returns error if the stream has been destroyed with an error.
added: v12.6.0
-->
* {boolean}
* Type: {boolean}
Is set to `true` immediately before the [`'finish'`][] event is emitted.
@ -941,7 +941,7 @@ Is set to `true` immediately before the [`'finish'`][] event is emitted.
added: v9.3.0
-->
* {number}
* Type: {number}
Return the value of `highWaterMark` passed when creating this `Writable`.
@ -951,7 +951,7 @@ Return the value of `highWaterMark` passed when creating this `Writable`.
added: v9.4.0
-->
* {number}
* Type: {number}
This property contains the number of bytes (or objects) in the queue
ready to be written. The value provides introspection data regarding
@ -965,7 +965,7 @@ added:
- v14.17.0
-->
* {boolean}
* Type: {boolean}
Is `true` if the stream's buffer has been full and stream will emit `'drain'`.
@ -975,7 +975,7 @@ Is `true` if the stream's buffer has been full and stream will emit `'drain'`.
added: v12.3.0
-->
* {boolean}
* Type: {boolean}
Getter for the property `objectMode` of a given `Writable` stream.
@ -1289,7 +1289,7 @@ readable.on('end', () => {
added: v0.9.4
-->
* {Error}
* Type: {Error}
The `'error'` event may be emitted by a `Readable` implementation at any time.
Typically, this may occur if the underlying stream is unable to generate data
@ -1418,7 +1418,7 @@ Implementors should not override this method, but instead implement
added: v18.0.0
-->
* {boolean}
* Type: {boolean}
Is `true` after `'close'` has been emitted.
@ -1428,7 +1428,7 @@ Is `true` after `'close'` has been emitted.
added: v8.0.0
-->
* {boolean}
* Type: {boolean}
Is `true` after [`readable.destroy()`][readable-destroy] has been called.
@ -1638,7 +1638,7 @@ been emitted will return `null`. No runtime error will be raised.
added: v11.4.0
-->
* {boolean}
* Type: {boolean}
Is `true` if it is safe to call [`readable.read()`][stream-read], which means
the stream has not been destroyed or emitted `'error'` or `'end'`.
@ -1655,7 +1655,7 @@ changes:
description: Marking the API stable.
-->
* {boolean}
* Type: {boolean}
Returns whether the stream was destroyed or errored before emitting `'end'`.
@ -1673,7 +1673,7 @@ changes:
description: Marking the API stable.
-->
* {boolean}
* Type: {boolean}
Returns whether `'data'` has been emitted.
@ -1683,7 +1683,7 @@ Returns whether `'data'` has been emitted.
added: v12.7.0
-->
* {null|string}
* Type: {null|string}
Getter for the property `encoding` of a given `Readable` stream. The `encoding`
property can be set using the [`readable.setEncoding()`][] method.
@ -1694,7 +1694,7 @@ property can be set using the [`readable.setEncoding()`][] method.
added: v12.9.0
-->
* {boolean}
* Type: {boolean}
Becomes `true` when [`'end'`][] event is emitted.
@ -1705,7 +1705,7 @@ added:
v18.0.0
-->
* {Error}
* Type: {Error}
Returns error if the stream has been destroyed with an error.
@ -1715,7 +1715,7 @@ Returns error if the stream has been destroyed with an error.
added: v9.4.0
-->
* {boolean}
* Type: {boolean}
This property reflects the current state of a `Readable` stream as described
in the [Three states][] section.
@ -1726,7 +1726,7 @@ in the [Three states][] section.
added: v9.3.0
-->
* {number}
* Type: {number}
Returns the value of `highWaterMark` passed when creating this `Readable`.
@ -1736,7 +1736,7 @@ Returns the value of `highWaterMark` passed when creating this `Readable`.
added: v9.4.0
-->
* {number}
* Type: {number}
This property contains the number of bytes (or objects) in the queue
ready to be read. The value provides introspection data regarding
@ -1748,7 +1748,7 @@ the status of the `highWaterMark`.
added: v12.3.0
-->
* {boolean}
* Type: {boolean}
Getter for the property `objectMode` of a given `Readable` stream.
@ -2678,7 +2678,7 @@ Examples of `Duplex` streams include:
added: v0.9.4
-->
* {boolean}
* Type: {boolean}
If `false` then the stream will automatically end the writable side when the
readable side ends. Set initially by the `allowHalfOpen` constructor option,

14
doc/api/test.md
View file

@ -1359,15 +1359,15 @@ changes:
parallel.
If `false`, it would only run one test file at a time.
**Default:** `false`.
* `cwd`: {string} Specifies the current working directory to be used by the test runner.
* `cwd` {string} Specifies the current working directory to be used by the test runner.
Serves as the base path for resolving files as if [running tests from the command line][] from that directory.
**Default:** `process.cwd()`.
* `files`: {Array} An array containing the list of files to run.
* `files` {Array} An array containing the list of files to run.
**Default:** Same as [running tests from the command line][].
* `forceExit`: {boolean} Configures the test runner to exit the process once
* `forceExit` {boolean} Configures the test runner to exit the process once
all known tests have finished executing even if the event loop would
otherwise remain active. **Default:** `false`.
* `globPatterns`: {Array} An array containing the list of glob patterns to
* `globPatterns` {Array} An array containing the list of glob patterns to
match test files. This option cannot be used together with `files`.
**Default:** Same as [running tests from the command line][].
* `inspectPort` {number|Function} Sets inspector port of test child process.
@ -1380,7 +1380,7 @@ changes:
`'process'`, each test file is run in a separate child process. If set to
`'none'`, all test files run in the current process. **Default:**
`'process'`.
* `only`: {boolean} If truthy, the test context will only run tests that
* `only` {boolean} If truthy, the test context will only run tests that
have the `only` option set
* `setup` {Function} A function that accepts the `TestsStream` instance
and can be used to setup listeners before any tests are run.
@ -1908,7 +1908,7 @@ added:
- v18.13.0
-->
* {Array}
* Type: {Array}
A getter that returns a copy of the internal array used to track calls to the
mock. Each entry in the array is an object with the following properties.
@ -2078,7 +2078,7 @@ of property mocks created via the [`MockTracker`][] APIs.
### `ctx.accesses`
* {Array}
* Type: {Array}
A getter that returns a copy of the internal array used to track accesses (get/set) to
the mocked property. Each entry in the array is an object with the following properties:

24
doc/api/tls.md
View file

@ -1044,7 +1044,7 @@ property is set only when `tlsSocket.authorized === false`.
added: v0.11.4
-->
* {boolean}
* Type: {boolean}
This property is `true` if the peer certificate was signed by one of the CAs
specified when creating the `tls.TLSSocket` instance, otherwise `false`.
@ -1395,7 +1395,7 @@ See the OpenSSL [`SSL_get_version`][] documentation for more information.
added: v0.11.4
-->
* {Buffer}
* Type: {Buffer}
Returns the TLS session data or `undefined` if no session was
negotiated. On the client, the data can be provided to the `session` option of
@ -1426,7 +1426,7 @@ for more information.
added: v0.11.4
-->
* {Buffer}
* Type: {Buffer}
For a client, returns the TLS session ticket if one is available, or
`undefined`. For a server, always returns `undefined`.
@ -1464,7 +1464,7 @@ See [Session Resumption][] for more information.
added: v0.11.4
-->
* {string}
* Type: {string}
Returns the string representation of the local IP address.
@ -1474,7 +1474,7 @@ Returns the string representation of the local IP address.
added: v0.11.4
-->
* {integer}
* Type: {integer}
Returns the numeric representation of the local port.
@ -1484,7 +1484,7 @@ Returns the numeric representation of the local port.
added: v0.11.4
-->
* {string}
* Type: {string}
Returns the string representation of the remote IP address. For example,
`'74.125.127.100'` or `'2001:4860:a005::68'`.
@ -1495,7 +1495,7 @@ Returns the string representation of the remote IP address. For example,
added: v0.11.4
-->
* {string}
* Type: {string}
Returns the string representation of the remote IP family. `'IPv4'` or `'IPv6'`.
@ -1505,7 +1505,7 @@ Returns the string representation of the remote IP family. `'IPv4'` or `'IPv6'`.
added: v0.11.4
-->
* {integer}
* Type: {integer}
Returns the numeric representation of the remote port. For example, `443`.
@ -2319,7 +2319,7 @@ console.log(tls.getCiphers()); // ['aes128-gcm-sha256', 'aes128-sha', ...]
added: v12.3.0
-->
* {string\[]}
* Type: {string\[]}
An immutable array of strings representing the root certificates (in PEM format)
from the bundled Mozilla CA store as supplied by the current Node.js version.
@ -2352,7 +2352,7 @@ information.
added: v11.4.0
-->
* {string} The default value of the `maxVersion` option of
* Type: {string} The default value of the `maxVersion` option of
[`tls.createSecureContext()`][]. It can be assigned any of the supported TLS
protocol versions, `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`.
**Default:** `'TLSv1.3'`, unless changed using CLI options. Using
@ -2366,7 +2366,7 @@ added: v11.4.0
added: v11.4.0
-->
* {string} The default value of the `minVersion` option of
* Type: {string} The default value of the `minVersion` option of
[`tls.createSecureContext()`][]. It can be assigned any of the supported TLS
protocol versions, `'TLSv1.3'`, `'TLSv1.2'`, `'TLSv1.1'`, or `'TLSv1'`.
Versions before TLSv1.2 may require downgrading the [OpenSSL Security Level][].
@ -2384,7 +2384,7 @@ added:
- v18.16.0
-->
* {string} The default value of the `ciphers` option of
* Type: {string} The default value of the `ciphers` option of
[`tls.createSecureContext()`][]. It can be assigned any of the supported
OpenSSL ciphers. Defaults to the content of
`crypto.constants.defaultCoreCipherList`, unless changed using CLI options

4
doc/api/tracing.md
View file

@ -147,7 +147,7 @@ set of enabled trace event categories.
added: v10.0.0
-->
* {string}
* Type: {string}
A comma-separated list of the trace event categories covered by this
`Tracing` object.
@ -210,7 +210,7 @@ Enables this `Tracing` object for the set of categories covered by the
added: v10.0.0
-->
* {boolean} `true` only if the `Tracing` object has been enabled.
* Type: {boolean} `true` only if the `Tracing` object has been enabled.
### `trace_events.createTracing(options)`

4
doc/api/tty.md
View file

@ -110,7 +110,7 @@ changes:
* `fd` {number} A file descriptor associated with a TTY.
* `options` {Object} Options passed to parent `net.Socket`,
see `options` of [`net.Socket` constructor][].
* Returns {tty.ReadStream}
* Returns: {tty.ReadStream}
Creates a `ReadStream` for `fd` associated with a TTY.
@ -121,7 +121,7 @@ added: v0.5.8
-->
* `fd` {number} A file descriptor associated with a TTY.
* Returns {tty.WriteStream}
* Returns: {tty.WriteStream}
Creates a `WriteStream` for `fd` associated with a TTY.

24
doc/api/url.md
View file

@ -207,7 +207,7 @@ myURL = new URL('foo:Example.com/', 'https://example.org/');
#### `url.hash`
* {string}
* Type: {string}
Gets and sets the fragment portion of the URL.
@ -228,7 +228,7 @@ percent-encode may vary somewhat from what the [`url.parse()`][] and
#### `url.host`
* {string}
* Type: {string}
Gets and sets the host portion of the URL.
@ -246,7 +246,7 @@ Invalid host values assigned to the `host` property are ignored.
#### `url.hostname`
* {string}
* Type: {string}
Gets and sets the host name portion of the URL. The key difference between
`url.host` and `url.hostname` is that `url.hostname` does _not_ include the
@ -272,7 +272,7 @@ Invalid host name values assigned to the `hostname` property are ignored.
#### `url.href`
* {string}
* Type: {string}
Gets and sets the serialized URL.
@ -306,7 +306,7 @@ changes:
returns `'null'` for it.
-->
* {string}
* Type: {string}
Gets the read-only serialization of the URL's origin.
@ -327,7 +327,7 @@ console.log(idnURL.hostname);
#### `url.password`
* {string}
* Type: {string}
Gets and sets the password portion of the URL.
@ -348,7 +348,7 @@ percent-encode may vary somewhat from what the [`url.parse()`][] and
#### `url.pathname`
* {string}
* Type: {string}
Gets and sets the path portion of the URL.
@ -376,7 +376,7 @@ changes:
description: The scheme "gopher" is no longer special.
-->
* {string}
* Type: {string}
Gets and sets the port portion of the URL.
@ -459,7 +459,7 @@ console.log(myURL.port);
#### `url.protocol`
* {string}
* Type: {string}
Gets and sets the protocol portion of the URL.
@ -524,7 +524,7 @@ According to the WHATWG URL Standard, special protocol schemes are `ftp`,
#### `url.search`
* {string}
* Type: {string}
Gets and sets the serialized query portion of the URL.
@ -545,7 +545,7 @@ and [`url.format()`][] methods would produce.
#### `url.searchParams`
* {URLSearchParams}
* Type: {URLSearchParams}
Gets the [`URLSearchParams`][] object representing the query parameters of the
URL. This property is read-only but the `URLSearchParams` object it provides
@ -572,7 +572,7 @@ console.log(myURL.search); // prints ?foo=%7Ebar
#### `url.username`
* {string}
* Type: {string}
Gets and sets the username portion of the URL.

22
doc/api/util.md
View file

@ -185,7 +185,7 @@ let log = debuglog('internals', (debug) => {
added: v14.9.0
-->
* {boolean}
* Type: {boolean}
The `util.debuglog().enabled` getter is used to create a test that can be used
in conditionals based on the existence of the `NODE_DEBUG` environment variable.
@ -1476,7 +1476,7 @@ changes:
description: This is now defined as a shared symbol.
-->
* {symbol} that can be used to declare custom inspect functions.
* Type: {symbol} that can be used to declare custom inspect functions.
In addition to being accessible through `util.inspect.custom`, this
symbol is [registered globally][global symbol registry] and can be
@ -1619,7 +1619,7 @@ console.log(String(myMIME));
### `mime.type`
* {string}
* Type: {string}
Gets and sets the type portion of the MIME.
@ -1651,7 +1651,7 @@ console.log(String(myMIME));
### `mime.subtype`
* {string}
* Type: {string}
Gets and sets the subtype portion of the MIME.
@ -1683,7 +1683,7 @@ console.log(String(myMIME));
### `mime.essence`
* {string}
* Type: {string}
Gets the essence of the MIME. This property is read only.
Use `mime.type` or `mime.subtype` to alter the MIME.
@ -1716,7 +1716,7 @@ console.log(String(myMIME));
### `mime.params`
* {MIMEParams}
* Type: {MIMEParams}
Gets the [`MIMEParams`][] object representing the
parameters of the MIME. This property is read-only. See
@ -2367,7 +2367,7 @@ changes:
description: This is now defined as a shared symbol.
-->
* {symbol} that can be used to declare custom promisified variants of functions,
* Type: {symbol} that can be used to declare custom promisified variants of functions,
see [Custom promisified functions][].
In addition to being accessible through `util.promisify.custom`, this
@ -2614,20 +2614,20 @@ If `textDecoder.fatal` is `true`, decoding errors that occur will result in a
### `textDecoder.encoding`
* {string}
* Type: {string}
The encoding supported by the `TextDecoder` instance.
### `textDecoder.fatal`
* {boolean}
* Type: {boolean}
The value will be `true` if decoding errors result in a `TypeError` being
thrown.
### `textDecoder.ignoreBOM`
* {boolean}
* Type: {boolean}
The value will be `true` if the decoding result will include the byte order
mark.
@ -2684,7 +2684,7 @@ const { read, written } = encoder.encodeInto(src, dest);
### `textEncoder.encoding`
* {string}
* Type: {string}
The encoding supported by the `TextEncoder` instance. Always set to `'utf-8'`.

20
doc/api/vm.md
View file

@ -120,7 +120,7 @@ any global object; rather, it is bound before each run, just for that run.
added: v5.7.0
-->
* {boolean|undefined}
* Type: {boolean|undefined}
When `cachedData` is supplied to create the `vm.Script`, this value will be set
to either `true` or `false` depending on acceptance of the data by V8.
@ -371,7 +371,7 @@ added:
- v18.13.0
-->
* {string|undefined}
* Type: {string|undefined}
When the script is compiled from a source that contains a source map magic
comment, this property will be set to the URL of the source map.
@ -577,7 +577,7 @@ const contextifiedObject = vm.createContext({
### `module.error`
* {any}
* Type: {any}
If the `module.status` is `'errored'`, this property contains the exception
thrown by the module during evaluation. If the status is anything else,
@ -618,7 +618,7 @@ Record][]s in the ECMAScript specification.
### `module.identifier`
* {string}
* Type: {string}
The identifier of the current module, as set in the constructor.
@ -693,7 +693,7 @@ Record][]s in the ECMAScript specification.
### `module.namespace`
* {Object}
* Type: {Object}
The namespace object of the module. This is only available after linking
(`module.link()`) has completed.
@ -703,7 +703,7 @@ specification.
### `module.status`
* {string}
* Type: {string}
The current status of the module. Will be one of:
@ -890,7 +890,7 @@ changes:
> Stability: 0 - Deprecated: Use [`sourceTextModule.moduleRequests`][] instead.
* {string\[]}
* Type: {string\[]}
The specifiers of all dependencies of this module. The returned array is frozen
to disallow any changes to it.
@ -904,7 +904,7 @@ the ECMAScript specification.
added: v24.4.0
-->
* {ModuleRequest\[]} Dependencies of this module.
* Type: {ModuleRequest\[]} Dependencies of this module.
The requested import dependencies of this module. The returned array is frozen
to disallow any changes to it.
@ -1057,7 +1057,7 @@ const vm = require('node:vm');
added: v24.4.0
-->
* {Object}
* Type: {Object}
* `specifier` {string} The specifier of the requested module.
* `attributes` {Object} The `"with"` value passed to the
[WithClause][] in a [ImportDeclaration][], or an empty object if no value was
@ -1146,7 +1146,7 @@ added:
- v20.12.0
-->
* {Object}
* Type: {Object}
Returns an object containing commonly used constants for VM operations.

2
doc/api/wasi.md
View file

@ -273,7 +273,7 @@ added:
- v12.16.0
-->
* {Object}
* Type: {Object}
`wasiImport` is an object that implements the WASI system call API. This object
should be passed as the `wasi_snapshot_preview1` import during the instantiation

22
doc/api/worker_threads.md
View file

@ -166,7 +166,7 @@ added:
- v22.14.0
-->
* {boolean}
* Type: {boolean}
Is `true` if this code is running inside of an internal [`Worker`][] thread (e.g the loader thread).
@ -208,7 +208,7 @@ console.log(isInternalThread); // false
added: v10.5.0
-->
* {boolean}
* Type: {boolean}
Is `true` if this code is not running inside of a [`Worker`][] thread.
@ -431,7 +431,7 @@ events using it.
added: v10.5.0
-->
* {null|MessagePort}
* Type: {null|MessagePort}
If this thread is a [`Worker`][], this is a [`MessagePort`][]
allowing communication with the parent thread. Messages sent using
@ -642,7 +642,7 @@ added:
- v12.16.0
-->
* {Object}
* Type: {Object}
* `maxYoungGenerationSizeMb` {number}
* `maxOldGenerationSizeMb` {number}
* `codeRangeSizeMb` {number}
@ -660,7 +660,7 @@ If this is used in the main thread, its value is an empty object.
added: v11.14.0
-->
* {symbol}
* Type: {symbol}
A special value that can be passed as the `env` option of the [`Worker`][]
constructor, to indicate that the current thread and the Worker thread should
@ -715,7 +715,7 @@ instances spawned from the current context.
added: v10.5.0
-->
* {integer}
* Type: {integer}
An integer identifier for the current thread. On the corresponding worker object
(if there is any), it is available as [`worker.threadId`][].
@ -1774,7 +1774,7 @@ added:
- v12.16.0
-->
* {Object}
* Type: {Object}
* `maxYoungGenerationSizeMb` {number}
* `maxOldGenerationSizeMb` {number}
* `codeRangeSizeMb` {number}
@ -1792,7 +1792,7 @@ If the worker has stopped, the return value is an empty object.
added: v10.5.0
-->
* {stream.Readable}
* Type: {stream.Readable}
This is a readable stream which contains data written to [`process.stderr`][]
inside the worker thread. If `stderr: true` was not passed to the
@ -1805,7 +1805,7 @@ inside the worker thread. If `stderr: true` was not passed to the
added: v10.5.0
-->
* {null|stream.Writable}
* Type: {null|stream.Writable}
If `stdin: true` was passed to the [`Worker`][] constructor, this is a
writable stream. The data written to this stream will be made available in
@ -1817,7 +1817,7 @@ the worker thread as [`process.stdin`][].
added: v10.5.0
-->
* {stream.Readable}
* Type: {stream.Readable}
This is a readable stream which contains data written to [`process.stdout`][]
inside the worker thread. If `stdout: true` was not passed to the
@ -1849,7 +1849,7 @@ Returns a Promise for the exit code that is fulfilled when the
added: v10.5.0
-->
* {integer}
* Type: {integer}
An integer identifier for the referenced thread. Inside the worker thread,
it is available as [`require('node:worker_threads').threadId`][].

2
doc/api/zlib.md
View file

@ -990,7 +990,7 @@ be used in pipes and similar stream operations.
added: v10.0.0
-->
* {number}
* Type: {number}
The `zlib.bytesWritten` property specifies the number of bytes written to
the engine, before the bytes are processed (compressed or decompressed,