From 3fc7871a465a82e6b88be891e134bd70fa3be5e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Nie=C3=9Fen?= Date: Sat, 19 Nov 2022 19:43:40 +0000 Subject: [PATCH 1/2] 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. --- doc/api/crypto.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 430bd3e7ca161b..1f3a5c181b69fa 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -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} @@ -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} From e74016710ad01a6bb7d42826f0f5caeb0729aaa8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Nie=C3=9Fen?= Date: Sun, 20 Nov 2022 18:46:24 +0100 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Filip Skokan --- doc/api/crypto.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 1f3a5c181b69fa..b0f7eefa020067 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -3740,7 +3740,7 @@ changes: * `groupName`: {string} Diffie-Hellman group name (DH). See [`crypto.getDiffieHellman()`][]. * `paramEncoding`: {string} Must be `'named'` or `'explicit'` (EC). - **Default:** `'named'` + **Default:** `'named'`. * `publicKeyEncoding`: {Object} See [`keyObject.export()`][]. * `privateKeyEncoding`: {Object} See [`keyObject.export()`][]. * `callback`: {Function} @@ -3854,7 +3854,7 @@ changes: * `groupName`: {string} Diffie-Hellman group name (DH). See [`crypto.getDiffieHellman()`][]. * `paramEncoding`: {string} Must be `'named'` or `'explicit'` (EC). - **Default:** `'named'` + **Default:** `'named'`. * `publicKeyEncoding`: {Object} See [`keyObject.export()`][]. * `privateKeyEncoding`: {Object} See [`keyObject.export()`][]. * Returns: {Object}