Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
doc: add missing documentation for paramEncoding
This option has existed ever since generateKeyPair was added in 2019 or
so, but I apparently forgot to document it.

PR-URL: #45523
Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com>
Reviewed-By: Filip Skokan <panva.ip@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
  • Loading branch information
tniessen authored and ruyadorno committed Nov 24, 2022
1 parent f08f6a6 commit 16643db
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/api/crypto.md
Expand Up @@ -3739,6 +3739,8 @@ changes:
* `generator`: {number} Custom generator (DH). **Default:** `2`.
* `groupName`: {string} Diffie-Hellman group name (DH). See
[`crypto.getDiffieHellman()`][].
* `paramEncoding`: {string} Must be `'named'` or `'explicit'` (EC).
**Default:** `'named'`.
* `publicKeyEncoding`: {Object} See [`keyObject.export()`][].
* `privateKeyEncoding`: {Object} See [`keyObject.export()`][].
* `callback`: {Function}
Expand Down Expand Up @@ -3851,6 +3853,8 @@ changes:
* `generator`: {number} Custom generator (DH). **Default:** `2`.
* `groupName`: {string} Diffie-Hellman group name (DH). See
[`crypto.getDiffieHellman()`][].
* `paramEncoding`: {string} Must be `'named'` or `'explicit'` (EC).
**Default:** `'named'`.
* `publicKeyEncoding`: {Object} See [`keyObject.export()`][].
* `privateKeyEncoding`: {Object} See [`keyObject.export()`][].
* Returns: {Object}
Expand Down

0 comments on commit 16643db

Please sign in to comment.