Skip to content

Commit e670ec8

Browse files
ovflowdgithub-actions[bot]
authored andcommitted
chore(api): sync auto-generated docs
1 parent 5a66d41 commit e670ec8

File tree

154 files changed

+94225
-412
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

154 files changed

+94225
-412
lines changed

content/api/v16/assert.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Stable
1313

1414
</Stability>
1515

16-
<Metadata version="v16.19.1" data={{"source_link":"lib/assert.js"}} />
16+
<Metadata version="v16.20.1" data={{"source_link":"lib/assert.js"}} />
1717

1818
The `node:assert` module provides a set of assertion functions for verifying
1919
invariants.

content/api/v16/async_context.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Stable
1313

1414
</Stability>
1515

16-
<Metadata version="v16.19.1" data={{"source_link":"lib/async_hooks.js"}} />
16+
<Metadata version="v16.20.1" data={{"source_link":"lib/async_hooks.js"}} />
1717

1818
### Introduction
1919

content/api/v16/async_hooks.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Experimental
1313

1414
</Stability>
1515

16-
<Metadata version="v16.19.1" data={{"source_link":"lib/async_hooks.js"}} />
16+
<Metadata version="v16.20.1" data={{"source_link":"lib/async_hooks.js"}} />
1717

1818
The `node:async_hooks` module provides an API to track asynchronous resources.
1919
It can be accessed using:

content/api/v16/buffer.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Stable
1313

1414
</Stability>
1515

16-
<Metadata version="v16.19.1" data={{"source_link":"lib/buffer.js"}} />
16+
<Metadata version="v16.20.1" data={{"source_link":"lib/buffer.js"}} />
1717

1818
`Buffer` objects are used to represent a fixed-length sequence of bytes. Many
1919
Node.js APIs support `Buffer`s.

content/api/v16/child_process.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Stable
1313

1414
</Stability>
1515

16-
<Metadata version="v16.19.1" data={{"source_link":"lib/child_process.js"}} />
16+
<Metadata version="v16.20.1" data={{"source_link":"lib/child_process.js"}} />
1717

1818
The `node:child_process` module provides the ability to spawn subprocesses in
1919
a manner that is similar, but not identical, to popen(3). This capability

content/api/v16/cluster.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Stable
1313

1414
</Stability>
1515

16-
<Metadata version="v16.19.1" data={{"source_link":"lib/cluster.js"}} />
16+
<Metadata version="v16.20.1" data={{"source_link":"lib/cluster.js"}} />
1717

1818
Clusters of Node.js processes can be used to run multiple instances of Node.js
1919
that can distribute workloads among their application threads. When process

content/api/v16/console.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Stable
1313

1414
</Stability>
1515

16-
<Metadata version="v16.19.1" data={{"source_link":"lib/console.js"}} />
16+
<Metadata version="v16.20.1" data={{"source_link":"lib/console.js"}} />
1717

1818
The `node:console` module provides a simple debugging console that is similar to
1919
the JavaScript console mechanism provided by web browsers.

content/api/v16/crypto.en.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Stable
1313

1414
</Stability>
1515

16-
<Metadata version="v16.19.1" data={{"source_link":"lib/crypto.js"}} />
16+
<Metadata version="v16.20.1" data={{"source_link":"lib/crypto.js"}} />
1717

1818
The `node:crypto` module provides cryptographic functionality that includes a
1919
set of wrappers for OpenSSL's hash, HMAC, cipher, decipher, sign, and verify
@@ -954,12 +954,17 @@ If `outputEncoding` is given a string is returned; otherwise, a
954954
* `encoding` [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) The [encoding][] of the return value.
955955
* Returns: [`Buffer`](/api/v16/buffer#buffer) | [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)
956956

957-
Generates private and public Diffie-Hellman key values, and returns
957+
Generates private and public Diffie-Hellman key values unless they have been
958+
generated or computed already, and returns
958959
the public key in the specified `encoding`. This key should be
959960
transferred to the other party.
960961
If `encoding` is provided a string is returned; otherwise a
961962
[`Buffer`][] is returned.
962963

964+
This function is a thin wrapper around [`DH_generate_key()`][]. In particular,
965+
once a private key has been generated or set, calling this function only updates
966+
the public key but does not generate a new private key.
967+
963968
#### <DataTag tag="M" /> `diffieHellman.getGenerator([encoding])`
964969

965970
<Metadata data={{"update":{"type":"added","version":["v0.5.0"]}}} />
@@ -1016,6 +1021,10 @@ Sets the Diffie-Hellman private key. If the `encoding` argument is provided,
10161021
to be a string. If no `encoding` is provided, `privateKey` is expected
10171022
to be a [`Buffer`][], `TypedArray`, or `DataView`.
10181023

1024+
This function does not automatically compute the associated public key. Either
1025+
[`diffieHellman.setPublicKey()`][] or [`diffieHellman.generateKeys()`][] can be
1026+
used to manually provide the public key or to automatically derive it.
1027+
10191028
#### <DataTag tag="M" /> `diffieHellman.setPublicKey(publicKey[, encoding])`
10201029

10211030
<Metadata data={{"update":{"type":"added","version":["v0.5.0"]}}} />
@@ -5094,6 +5103,7 @@ See the [list of SSL OP Flags][] for details.
50945103
[Web Crypto API documentation]: /api/v16/webcrypto
50955104
[`BN_is_prime_ex`]: https://www.openssl.org/docs/man1.1.1/man3/BN_is_prime_ex.html
50965105
[`Buffer`]: /api/v16/buffer
5106+
[`DH_generate_key()`]: https://www.openssl.org/docs/man3.0/man3/DH_generate_key.html
50975107
[`DiffieHellmanGroup`]: #class-diffiehellmangroup
50985108
[`EVP_BytesToKey`]: https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html
50995109
[`KeyObject`]: #class-keyobject
@@ -5128,6 +5138,7 @@ See the [list of SSL OP Flags][] for details.
51285138
[`crypto.scrypt()`]: #cryptoscryptpassword-salt-keylen-options-callback
51295139
[`decipher.final()`]: #decipherfinaloutputencoding
51305140
[`decipher.update()`]: #decipherupdatedata-inputencoding-outputencoding
5141+
[`diffieHellman.generateKeys()`]: #diffiehellmangeneratekeysencoding
51315142
[`diffieHellman.setPublicKey()`]: #diffiehellmansetpublickeypublickey-encoding
51325143
[`ecdh.generateKeys()`]: #ecdhgeneratekeysencoding-format
51335144
[`ecdh.setPrivateKey()`]: #ecdhsetprivatekeyprivatekey-encoding

content/api/v16/dgram.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Stable
1515

1616
<Metadata data={{"name":"dgram"}} />
1717

18-
<Metadata version="v16.19.1" data={{"source_link":"lib/dgram.js"}} />
18+
<Metadata version="v16.20.1" data={{"source_link":"lib/dgram.js"}} />
1919

2020
The `node:dgram` module provides an implementation of UDP datagram sockets.
2121

content/api/v16/diagnostics_channel.en.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Experimental
1313

1414
</Stability>
1515

16-
<Metadata version="v16.19.1" data={{"source_link":"lib/diagnostics_channel.js"}} />
16+
<Metadata version="v16.20.1" data={{"source_link":"lib/diagnostics_channel.js"}} />
1717

1818
The `node:diagnostics_channel` module provides an API to create named channels
1919
to report arbitrary message data for diagnostics purposes.

0 commit comments

Comments
 (0)