Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fixup! more
  • Loading branch information
avivkeller committed Jul 11, 2025
commit 0880f5784e639e72f6b57608a0787e900ac447d3
60 changes: 30 additions & 30 deletions doc/api/crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -1996,14 +1996,14 @@ changes:
-->

* {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
* `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
Expand Down Expand Up @@ -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}

Expand All @@ -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
Expand Down Expand Up @@ -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`.
Expand Down Expand Up @@ -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-->
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down
2 changes: 1 addition & 1 deletion doc/api/globals.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ changes:
description: Added the new optional reason argument.
-->

* `reason`: {any}
* `reason` {any}
* Returns: {AbortSignal}

Returns a new already aborted `AbortSignal`.
Expand Down
14 changes: 7 additions & 7 deletions doc/api/module.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
14 changes: 7 additions & 7 deletions doc/api/sqlite.md
Original file line number Diff line number Diff line change
Expand Up @@ -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()`][].

Expand Down Expand Up @@ -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()`][].
Expand Down
10 changes: 5 additions & 5 deletions doc/api/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down
Loading