Skip to content

doc: fix return type #29696

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

doc: fix return type #29696

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
38b1641
doc: fix return type
Sep 24, 2019
e10a6f0
doc: add DiffieHellmanGroup type
Sep 28, 2019
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
6 changes: 3 additions & 3 deletions doc/api/crypto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1824,7 +1824,7 @@ added: v0.9.3
-->

* `name` {string}
* Returns: {DiffieHellman}
* Returns: {DiffieHellmanGroup}

An alias for [`crypto.getDiffieHellman()`][]

Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions tools/doc/type-parser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down