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

doc: format safely for `doc-kit` · nodejs/node@5a98bff · GitHub

/ node Public

Commit 5a98bff

Browse files
avivkeller
authored and
targos
committed
doc: format safely for doc-kit
PR-URL: #59229 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
1 parent 564e604 commit 5a98bff

13 files changed

Lines changed: 190 additions & 207 deletions

‎doc/api/crypto.md‎

Lines changed: 51 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -3602,18 +3602,18 @@ changes:
36023602
`ERR_INVALID_CALLBACK`.
36033603
-->
36043604

3605-
* `type`: {string} The intended use of the generated secret key. Currently
3605+
* `type` {string} The intended use of the generated secret key. Currently
36063606
accepted values are `'hmac'` and `'aes'`.
3607-
* `options`: {Object}
3608-
* `length`: {number} The bit length of the key to generate. This must be a
3607+
* `options` {Object}
3608+
* `length` {number} The bit length of the key to generate. This must be a
36093609
value greater than 0.
36103610
* If `type` is `'hmac'`, the minimum is 8, and the maximum length is
36113611
2<sup>31</sup>-1. If the value is not a multiple of 8, the generated
36123612
key will be truncated to `Math.floor(length / 8)`.
36133613
* If `type` is `'aes'`, the length must be one of `128`, `192`, or `256`.
3614-
* `callback`: {Function}
3615-
* `err`: {Error}
3616-
* `key`: {KeyObject}
3614+
* `callback` {Function}
3615+
* `err` {Error}
3616+
* `key` {KeyObject}
36173617

36183618
Asynchronously generates a new random secret key of the given `length`. The
36193619
`type` will determine which validations will be performed on the `length`.
@@ -3677,30 +3677,30 @@ changes:
36773677
produce key objects if no encoding was specified.
36783678
-->
36793679

3680-
* `type`: {string} Must be `'rsa'`, `'rsa-pss'`, `'dsa'`, `'ec'`, `'ed25519'`,
3680+
* `type` {string} Must be `'rsa'`, `'rsa-pss'`, `'dsa'`, `'ec'`, `'ed25519'`,
36813681
`'ed448'`, `'x25519'`, `'x448'`, or `'dh'`.
3682-
* `options`: {Object}
3683-
* `modulusLength`: {number} Key size in bits (RSA, DSA).
3684-
* `publicExponent`: {number} Public exponent (RSA). **Default:** `0x10001`.
3685-
* `hashAlgorithm`: {string} Name of the message digest (RSA-PSS).
3686-
* `mgf1HashAlgorithm`: {string} Name of the message digest used by
3682+
* `options` {Object}
3683+
* `modulusLength` {number} Key size in bits (RSA, DSA).
3684+
* `publicExponent` {number} Public exponent (RSA). **Default:** `0x10001`.
3685+
* `hashAlgorithm` {string} Name of the message digest (RSA-PSS).
3686+
* `mgf1HashAlgorithm` {string} Name of the message digest used by
36873687
MGF1 (RSA-PSS).
3688-
* `saltLength`: {number} Minimal salt length in bytes (RSA-PSS).
3689-
* `divisorLength`: {number} Size of `q` in bits (DSA).
3690-
* `namedCurve`: {string} Name of the curve to use (EC).
3691-
* `prime`: {Buffer} The prime parameter (DH).
3692-
* `primeLength`: {number} Prime length in bits (DH).
3693-
* `generator`: {number} Custom generator (DH). **Default:** `2`.
3694-
* `groupName`: {string} Diffie-Hellman group name (DH). See
3688+
* `saltLength` {number} Minimal salt length in bytes (RSA-PSS).
3689+
* `divisorLength` {number} Size of `q` in bits (DSA).
3690+
* `namedCurve` {string} Name of the curve to use (EC).
3691+
* `prime` {Buffer} The prime parameter (DH).
3692+
* `primeLength` {number} Prime length in bits (DH).
3693+
* `generator` {number} Custom generator (DH). **Default:** `2`.
3694+
* `groupName` {string} Diffie-Hellman group name (DH). See
36953695
[`crypto.getDiffieHellman()`][].
3696-
* `paramEncoding`: {string} Must be `'named'` or `'explicit'` (EC).
3696+
* `paramEncoding` {string} Must be `'named'` or `'explicit'` (EC).
36973697
**Default:** `'named'`.
3698-
* `publicKeyEncoding`: {Object} See [`keyObject.export()`][].
3699-
* `privateKeyEncoding`: {Object} See [`keyObject.export()`][].
3700-
* `callback`: {Function}
3701-
* `err`: {Error}
3702-
* `publicKey`: {string | Buffer | KeyObject}
3703-
* `privateKey`: {string | Buffer | KeyObject}
3698+
* `publicKeyEncoding` {Object} See [`keyObject.export()`][].
3699+
* `privateKeyEncoding` {Object} See [`keyObject.export()`][].
3700+
* `callback` {Function}
3701+
* `err` {Error}
3702+
* `publicKey` {string | Buffer | KeyObject}
3703+
* `privateKey` {string | Buffer | KeyObject}
37043704

37053705
Generates a new asymmetric key pair of the given `type`. RSA, RSA-PSS, DSA, EC,
37063706
Ed25519, Ed448, X25519, X448, and DH are currently supported.
@@ -3791,29 +3791,29 @@ changes:
37913791
produce key objects if no encoding was specified.
37923792
-->
37933793

3794-
* `type`: {string} Must be `'rsa'`, `'rsa-pss'`, `'dsa'`, `'ec'`, `'ed25519'`,
3794+
* `type` {string} Must be `'rsa'`, `'rsa-pss'`, `'dsa'`, `'ec'`, `'ed25519'`,
37953795
`'ed448'`, `'x25519'`, `'x448'`, or `'dh'`.
3796-
* `options`: {Object}
3797-
* `modulusLength`: {number} Key size in bits (RSA, DSA).
3798-
* `publicExponent`: {number} Public exponent (RSA). **Default:** `0x10001`.
3799-
* `hashAlgorithm`: {string} Name of the message digest (RSA-PSS).
3800-
* `mgf1HashAlgorithm`: {string} Name of the message digest used by
3796+
* `options` {Object}
3797+
* `modulusLength` {number} Key size in bits (RSA, DSA).
3798+
* `publicExponent` {number} Public exponent (RSA). **Default:** `0x10001`.
3799+
* `hashAlgorithm` {string} Name of the message digest (RSA-PSS).
3800+
* `mgf1HashAlgorithm` {string} Name of the message digest used by
38013801
MGF1 (RSA-PSS).
3802-
* `saltLength`: {number} Minimal salt length in bytes (RSA-PSS).
3803-
* `divisorLength`: {number} Size of `q` in bits (DSA).
3804-
* `namedCurve`: {string} Name of the curve to use (EC).
3805-
* `prime`: {Buffer} The prime parameter (DH).
3806-
* `primeLength`: {number} Prime length in bits (DH).
3807-
* `generator`: {number} Custom generator (DH). **Default:** `2`.
3808-
* `groupName`: {string} Diffie-Hellman group name (DH). See
3802+
* `saltLength` {number} Minimal salt length in bytes (RSA-PSS).
3803+
* `divisorLength` {number} Size of `q` in bits (DSA).
3804+
* `namedCurve` {string} Name of the curve to use (EC).
3805+
* `prime` {Buffer} The prime parameter (DH).
3806+
* `primeLength` {number} Prime length in bits (DH).
3807+
* `generator` {number} Custom generator (DH). **Default:** `2`.
3808+
* `groupName` {string} Diffie-Hellman group name (DH). See
38093809
[`crypto.getDiffieHellman()`][].
3810-
* `paramEncoding`: {string} Must be `'named'` or `'explicit'` (EC).
3810+
* `paramEncoding` {string} Must be `'named'` or `'explicit'` (EC).
38113811
**Default:** `'named'`.
3812-
* `publicKeyEncoding`: {Object} See [`keyObject.export()`][].
3813-
* `privateKeyEncoding`: {Object} See [`keyObject.export()`][].
3812+
* `publicKeyEncoding` {Object} See [`keyObject.export()`][].
3813+
* `privateKeyEncoding` {Object} See [`keyObject.export()`][].
38143814
* Returns: {Object}
3815-
* `publicKey`: {string | Buffer | KeyObject}
3816-
* `privateKey`: {string | Buffer | KeyObject}
3815+
* `publicKey` {string | Buffer | KeyObject}
3816+
* `privateKey` {string | Buffer | KeyObject}
38173817

38183818
Generates a new asymmetric key pair of the given `type`. RSA, RSA-PSS, DSA, EC,
38193819
Ed25519, Ed448, X25519, X448, and DH are currently supported.
@@ -3882,10 +3882,10 @@ it will be a buffer containing the data encoded as DER.
38823882
added: v15.0.0
38833883
-->
38843884

3885-
* `type`: {string} The intended use of the generated secret key. Currently
3885+
* `type` {string} The intended use of the generated secret key. Currently
38863886
accepted values are `'hmac'` and `'aes'`.
3887-
* `options`: {Object}
3888-
* `length`: {number} The bit length of the key to generate.
3887+
* `options` {Object}
3888+
* `length` {number} The bit length of the key to generate.
38893889
* If `type` is `'hmac'`, the minimum is 8, and the maximum length is
38903890
2<sup>31</sup>-1. If the value is not a multiple of 8, the generated
38913891
key will be truncated to `Math.floor(length / 8)`.
@@ -4026,10 +4026,10 @@ the process unresponsive.
40264026
added: v15.0.0
40274027
-->
40284028

4029-
* `nameOrNid`: {string|number} The name or nid of the cipher to query.
4030-
* `options`: {Object}
4031-
* `keyLength`: {number} A test key length.
4032-
* `ivLength`: {number} A test IV length.
4029+
* `nameOrNid` {string|number} The name or nid of the cipher to query.
4030+
* `options` {Object}
4031+
* `keyLength` {number} A test key length.
4032+
* `ivLength` {number} A test IV length.
40334033
* Returns: {Object}
40344034
* `name` {string} The name of the cipher
40354035
* `nid` {number} The nid of the cipher

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL