diff options
| author | Ouyang Yadong <oyydoibh@gmail.com> | 2018-10-31 16:53:38 +0800 |
|---|---|---|
| committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-11-02 00:36:40 +0200 |
| commit | 5689d553920e6276065517966fcaf8e02f498fc1 (patch) | |
| tree | 56bf834f563b1767b753e6d3693c8bcd8d87a209 /doc/api/crypto.md | |
| parent | 98819dfa5853d7c8355d70aa1aa7783677c391e5 (diff) | |
| download | android-node-v8-5689d553920e6276065517966fcaf8e02f498fc1.tar.gz android-node-v8-5689d553920e6276065517966fcaf8e02f498fc1.tar.bz2 android-node-v8-5689d553920e6276065517966fcaf8e02f498fc1.zip | |
doc: add types and their corresponding return values
This commit supplements some types and their corresponding return
values in docs, including `AsyncResource`, `DiffieHellman`,
`ECDH`, `https.Server`, `repl.REPLServer`.
PR-URL: https://github.com/nodejs/node/pull/23998
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'doc/api/crypto.md')
| -rw-r--r-- | doc/api/crypto.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md index c00fad6578..d12eb6d136 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -1533,6 +1533,7 @@ changes: * `generator` {number | string | Buffer | TypedArray | DataView} **Default:** `2` * `generatorEncoding` {string} +* Returns: {DiffieHellman} Creates a `DiffieHellman` key exchange object using the supplied `prime` and an optional specific `generator`. @@ -1556,6 +1557,7 @@ added: v0.5.0 * `primeLength` {number} * `generator` {number | string | Buffer | TypedArray | DataView} **Default:** `2` +* Returns: {DiffieHellman} Creates a `DiffieHellman` key exchange object and generates a prime of `primeLength` bits using an optional specific numeric `generator`. @@ -1566,6 +1568,7 @@ If `generator` is not specified, the value `2` is used. added: v0.11.14 --> * `curveName` {string} +* Returns: {ECDH} Creates an Elliptic Curve Diffie-Hellman (`ECDH`) key exchange object using a predefined curve specified by the `curveName` string. Use @@ -1818,7 +1821,7 @@ console.log(curves); // ['Oakley-EC2N-3', 'Oakley-EC2N-4', ...] added: v0.7.5 --> * `groupName` {string} -* Returns: {Object} +* Returns: {DiffieHellman} Creates a predefined `DiffieHellman` key exchange object. The supported groups are: `'modp1'`, `'modp2'`, `'modp5'` (defined in |