Skip to content

Commit 4c67437

Browse files
Linkgorontargos
authored andcommitted
doc: clarify DiffieHellmanGroup class docs
Make it clearer in the docs that DiffieHellmanGroup does not support changing the keys after creation. PR-URL: #38363 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Adrian Estrada <edsadr@gmail.com>
1 parent e90c60b commit 4c67437

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

doc/api/crypto.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -735,8 +735,10 @@ module):
735735
added: v0.7.5
736736
-->
737737

738-
The `DiffieHellmanGroup` class takes a well-known modp group as its argument but
739-
otherwise works the same as `DiffieHellman`.
738+
The `DiffieHellmanGroup` class takes a well-known modp group as its argument.
739+
It works the same as `DiffieHellman`, except that it does not allow changing
740+
its keys after creation. In other words, it does not implement `setPublicKey()`
741+
or `setPrivateKey()` methods.
740742

741743
```js
742744
const name = 'modp1';

0 commit comments

Comments
 (0)