From a0498606a0fcc3bc6ca9fd038850cb0d7ebae484 Mon Sep 17 00:00:00 2001 From: exoego Date: Wed, 25 Sep 2019 05:27:37 +0900 Subject: [PATCH] doc: fix return type for crypto.createDiffieHellmanGroup() PR-URL: https://github.com/nodejs/node/pull/29696 Reviewed-By: Rich Trott --- doc/api/crypto.md | 6 +++--- tools/doc/type-parser.js | 1 + 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 5ac8b09820ef60..ba1582bd78d542 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -1824,7 +1824,7 @@ added: v0.9.3 --> * `name` {string} -* Returns: {DiffieHellman} +* Returns: {DiffieHellmanGroup} An alias for [`crypto.getDiffieHellman()`][] @@ -2194,9 +2194,9 @@ added: v0.7.5 --> * `groupName` {string} -* Returns: {DiffieHellman} +* Returns: {DiffieHellmanGroup} -Creates a predefined `DiffieHellman` key exchange object. The +Creates a predefined `DiffieHellmanGroup` key exchange object. The supported groups are: `'modp1'`, `'modp2'`, `'modp5'` (defined in [RFC 2412][], but see [Caveats][]) and `'modp14'`, `'modp15'`, `'modp16'`, `'modp17'`, `'modp18'` (defined in [RFC 3526][]). The diff --git a/tools/doc/type-parser.js b/tools/doc/type-parser.js index 35039b68d95c8f..4c3ec0503e7701 100644 --- a/tools/doc/type-parser.js +++ b/tools/doc/type-parser.js @@ -52,6 +52,7 @@ const customTypesMap = { 'Cipher': 'crypto.html#crypto_class_cipher', 'Decipher': 'crypto.html#crypto_class_decipher', 'DiffieHellman': 'crypto.html#crypto_class_diffiehellman', + 'DiffieHellmanGroup': 'crypto.html#crypto_class_diffiehellmangroup', 'ECDH': 'crypto.html#crypto_class_ecdh', 'Hash': 'crypto.html#crypto_class_hash', 'Hmac': 'crypto.html#crypto_class_hmac',