chore(api): sync auto-generated docs

nodejs · Jul 3, 2023 · e670ec8 · e670ec8
1 parent 5a66d41
commit e670ec8
Show file tree

Hide file tree

Showing 154 changed files with 94,225 additions and 412 deletions.
diff --git a/content/api/v16/assert.en.md b/content/api/v16/assert.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/assert.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/assert.js"}} />
 
 The `node:assert` module provides a set of assertion functions for verifying
 invariants.

diff --git a/content/api/v16/async_context.en.md b/content/api/v16/async_context.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/async_hooks.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/async_hooks.js"}} />
 
 ### Introduction
 

diff --git a/content/api/v16/async_hooks.en.md b/content/api/v16/async_hooks.en.md
@@ -13,7 +13,7 @@ Experimental
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/async_hooks.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/async_hooks.js"}} />
 
 The `node:async_hooks` module provides an API to track asynchronous resources.
 It can be accessed using:

diff --git a/content/api/v16/buffer.en.md b/content/api/v16/buffer.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/buffer.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/buffer.js"}} />
 
 `Buffer` objects are used to represent a fixed-length sequence of bytes. Many
 Node.js APIs support `Buffer`s.

diff --git a/content/api/v16/child_process.en.md b/content/api/v16/child_process.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/child_process.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/child_process.js"}} />
 
 The `node:child_process` module provides the ability to spawn subprocesses in
 a manner that is similar, but not identical, to popen(3). This capability

diff --git a/content/api/v16/cluster.en.md b/content/api/v16/cluster.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/cluster.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/cluster.js"}} />
 
 Clusters of Node.js processes can be used to run multiple instances of Node.js
 that can distribute workloads among their application threads. When process

diff --git a/content/api/v16/console.en.md b/content/api/v16/console.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/console.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/console.js"}} />
 
 The `node:console` module provides a simple debugging console that is similar to
 the JavaScript console mechanism provided by web browsers.

diff --git a/content/api/v16/crypto.en.md b/content/api/v16/crypto.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/crypto.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/crypto.js"}} />
 
 The `node:crypto` module provides cryptographic functionality that includes a
 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
 * `encoding` [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type) The [encoding][] of the return value.
 * Returns: [`Buffer`](/api/v16/buffer#buffer) | [`string`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type)
 
-Generates private and public Diffie-Hellman key values, and returns
+Generates private and public Diffie-Hellman key values unless they have been
+generated or computed already, and returns
 the public key in the specified `encoding`. This key should be
 transferred to the other party.
 If `encoding` is provided a string is returned; otherwise a
 [`Buffer`][] is returned.
 
+This function is a thin wrapper around [`DH_generate_key()`][]. In particular,
+once a private key has been generated or set, calling this function only updates
+the public key but does not generate a new private key.
+
 #### <DataTag tag="M" /> `diffieHellman.getGenerator([encoding])`
 
 <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,
 to be a string. If no `encoding` is provided, `privateKey` is expected
 to be a [`Buffer`][], `TypedArray`, or `DataView`.
 
+This function does not automatically compute the associated public key. Either
+[`diffieHellman.setPublicKey()`][] or [`diffieHellman.generateKeys()`][] can be
+used to manually provide the public key or to automatically derive it.
+
 #### <DataTag tag="M" /> `diffieHellman.setPublicKey(publicKey[, encoding])`
 
 <Metadata data={{"update":{"type":"added","version":["v0.5.0"]}}} />
@@ -5094,6 +5103,7 @@ See the [list of SSL OP Flags][] for details.
 [Web Crypto API documentation]: /api/v16/webcrypto
 [`BN_is_prime_ex`]: https://www.openssl.org/docs/man1.1.1/man3/BN_is_prime_ex.html
 [`Buffer`]: /api/v16/buffer
+[`DH_generate_key()`]: https://www.openssl.org/docs/man3.0/man3/DH_generate_key.html
 [`DiffieHellmanGroup`]: #class-diffiehellmangroup
 [`EVP_BytesToKey`]: https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html
 [`KeyObject`]: #class-keyobject
@@ -5128,6 +5138,7 @@ See the [list of SSL OP Flags][] for details.
 [`crypto.scrypt()`]: #cryptoscryptpassword-salt-keylen-options-callback
 [`decipher.final()`]: #decipherfinaloutputencoding
 [`decipher.update()`]: #decipherupdatedata-inputencoding-outputencoding
+[`diffieHellman.generateKeys()`]: #diffiehellmangeneratekeysencoding
 [`diffieHellman.setPublicKey()`]: #diffiehellmansetpublickeypublickey-encoding
 [`ecdh.generateKeys()`]: #ecdhgeneratekeysencoding-format
 [`ecdh.setPrivateKey()`]: #ecdhsetprivatekeyprivatekey-encoding

diff --git a/content/api/v16/dgram.en.md b/content/api/v16/dgram.en.md
@@ -15,7 +15,7 @@ Stable
 
 <Metadata data={{"name":"dgram"}} />
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/dgram.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/dgram.js"}} />
 
 The `node:dgram` module provides an implementation of UDP datagram sockets.
 

diff --git a/content/api/v16/diagnostics_channel.en.md b/content/api/v16/diagnostics_channel.en.md
@@ -13,7 +13,7 @@ Experimental
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/diagnostics_channel.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/diagnostics_channel.js"}} />
 
 The `node:diagnostics_channel` module provides an API to create named channels
 to report arbitrary message data for diagnostics purposes.

diff --git a/content/api/v16/dns.en.md b/content/api/v16/dns.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/dns.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/dns.js"}} />
 
 The `node:dns` module enables name resolution. For example, use it to look up IP
 addresses of host names.

diff --git a/content/api/v16/domain.en.md b/content/api/v16/domain.en.md
@@ -15,7 +15,7 @@ Deprecated
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/domain.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/domain.js"}} />
 
 **This module is pending deprecation.** Once a replacement API has been
 finalized, this module will be fully deprecated. Most developers should

diff --git a/content/api/v16/events.en.md b/content/api/v16/events.en.md
@@ -15,7 +15,7 @@ Stable
 
 <Metadata data={{"type":"module"}} />
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/events.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/events.js"}} />
 
 Much of the Node.js core API is built around an idiomatic asynchronous
 event-driven architecture in which certain kinds of objects (called "emitters")

diff --git a/content/api/v16/fs.en.md b/content/api/v16/fs.en.md
@@ -15,7 +15,7 @@ Stable
 
 <Metadata data={{"name":"fs"}} />
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/fs.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/fs.js"}} />
 
 The `node:fs` module enables interacting with the file system in a
 way modeled on standard POSIX functions.

diff --git a/content/api/v16/http.en.md b/content/api/v16/http.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/http.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/http.js"}} />
 
 To use the HTTP server and client one must `require('node:http')`.
 

diff --git a/content/api/v16/http2.en.md b/content/api/v16/http2.en.md
@@ -15,7 +15,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/http2.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/http2.js"}} />
 
 The `node:http2` module provides an implementation of the [HTTP/2][] protocol.
 It can be accessed using:

diff --git a/content/api/v16/https.en.md b/content/api/v16/https.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/https.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/https.js"}} />
 
 HTTPS is the HTTP protocol over TLS/SSL. In Node.js this is implemented as a
 separate module.

diff --git a/content/api/v16/inspector.en.md b/content/api/v16/inspector.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/inspector.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/inspector.js"}} />
 
 The `node:inspector` module provides an API for interacting with the V8
 inspector.

diff --git a/content/api/v16/net.en.md b/content/api/v16/net.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/net.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/net.js"}} />
 
 The `node:net` module provides an asynchronous network API for creating stream-based
 TCP or [IPC][] servers ([`net.createServer()`][]) and clients

diff --git a/content/api/v16/os.en.md b/content/api/v16/os.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/os.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/os.js"}} />
 
 The `node:os` module provides operating system-related utility methods and
 properties. It can be accessed using:

diff --git a/content/api/v16/path.en.md b/content/api/v16/path.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/path.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/path.js"}} />
 
 The `node:path` module provides utilities for working with file and directory
 paths. It can be accessed using:

diff --git a/content/api/v16/perf_hooks.en.md b/content/api/v16/perf_hooks.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/perf_hooks.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/perf_hooks.js"}} />
 
 This module provides an implementation of a subset of the W3C
 [Web Performance APIs][] as well as additional APIs for

diff --git a/content/api/v16/process.en.md b/content/api/v16/process.en.md
@@ -9,7 +9,7 @@ version: 'v16'
 
 <Metadata data={{"type":"global"}} />
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/process.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/process.js"}} />
 
 The `process` object provides information about, and control over, the current
 Node.js process.

diff --git a/content/api/v16/punycode.en.md b/content/api/v16/punycode.en.md
@@ -15,7 +15,7 @@ Deprecated
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/punycode.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/punycode.js"}} />
 
 **The version of the punycode module bundled in Node.js is being deprecated.**
 In a future major version of Node.js this module will be removed. Users

diff --git a/content/api/v16/querystring.en.md b/content/api/v16/querystring.en.md
@@ -15,7 +15,7 @@ Legacy
 
 <Metadata data={{"name":"querystring"}} />
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/querystring.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/querystring.js"}} />
 
 The `node:querystring` module provides utilities for parsing and formatting URL
 query strings. It can be accessed using:

diff --git a/content/api/v16/readline.en.md b/content/api/v16/readline.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/readline.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/readline.js"}} />
 
 The `node:readline` module provides an interface for reading data from a
 [Readable][] stream (such as [`process.stdin`][]) one line at a time.

diff --git a/content/api/v16/repl.en.md b/content/api/v16/repl.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/repl.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/repl.js"}} />
 
 The `node:repl` module provides a Read-Eval-Print-Loop (REPL) implementation
 that is available both as a standalone program or includible in other

diff --git a/content/api/v16/stream.en.md b/content/api/v16/stream.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/stream.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/stream.js"}} />
 
 A stream is an abstract interface for working with streaming data in Node.js.
 The `node:stream` module provides an API for implementing the stream interface.

diff --git a/content/api/v16/string_decoder.en.md b/content/api/v16/string_decoder.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/string_decoder.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/string_decoder.js"}} />
 
 The `node:string_decoder` module provides an API for decoding `Buffer` objects
 into strings in a manner that preserves encoded multi-byte UTF-8 and UTF-16

diff --git a/content/api/v16/test.en.md b/content/api/v16/test.en.md
@@ -13,7 +13,7 @@ Experimental
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/test.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/test.js"}} />
 
 The `node:test` module facilitates the creation of JavaScript tests that
 report results in [TAP][] format. To access it:

diff --git a/content/api/v16/timers.en.md b/content/api/v16/timers.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/timers.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/timers.js"}} />
 
 The `timer` module exposes a global API for scheduling functions to
 be called at some future period of time. Because the timer functions are

diff --git a/content/api/v16/tls.en.md b/content/api/v16/tls.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/tls.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/tls.js"}} />
 
 The `node:tls` module provides an implementation of the Transport Layer Security
 (TLS) and Secure Socket Layer (SSL) protocols that is built on top of OpenSSL.

diff --git a/content/api/v16/tracing.en.md b/content/api/v16/tracing.en.md
@@ -13,7 +13,7 @@ Experimental
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/trace_events.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/trace_events.js"}} />
 
 The `node:trace_events` module provides a mechanism to centralize tracing
 information generated by V8, Node.js core, and userspace code.

diff --git a/content/api/v16/tty.en.md b/content/api/v16/tty.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/tty.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/tty.js"}} />
 
 The `node:tty` module provides the `tty.ReadStream` and `tty.WriteStream`
 classes. In most cases, it will not be necessary or possible to use this module

diff --git a/content/api/v16/url.en.md b/content/api/v16/url.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/url.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/url.js"}} />
 
 The `node:url` module provides utilities for URL resolution and parsing. It can
 be accessed using:

diff --git a/content/api/v16/util.en.md b/content/api/v16/util.en.md
@@ -13,7 +13,7 @@ Stable
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/util.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/util.js"}} />
 
 The `node:util` module supports the needs of Node.js internal APIs. Many of the
 utilities are useful for application and module developers as well. To access

diff --git a/content/api/v16/v8.en.md b/content/api/v16/v8.en.md
@@ -7,7 +7,7 @@ version: 'v16'
 
 <Metadata data={{"update":{"type":"introduced_in","version":["v4.0.0"]}}} />
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/v8.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/v8.js"}} />
 
 The `node:v8` module exposes APIs that are specific to the version of [V8][]
 built into the Node.js binary. It can be accessed using:

diff --git a/content/api/v16/vm.en.md b/content/api/v16/vm.en.md
@@ -15,7 +15,7 @@ Stable
 
 <Metadata data={{"name":"vm"}} />
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/vm.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/vm.js"}} />
 
 The `node:vm` module enables compiling and running code within V8 Virtual
 Machine contexts.

diff --git a/content/api/v16/wasi.en.md b/content/api/v16/wasi.en.md
@@ -13,7 +13,7 @@ Experimental
 
 </Stability>
 
-<Metadata version="v16.19.1" data={{"source_link":"lib/wasi.js"}} />
+<Metadata version="v16.20.1" data={{"source_link":"lib/wasi.js"}} />
 
 The WASI API provides an implementation of the [WebAssembly System Interface][]
 specification. WASI gives sandboxed WebAssembly applications access to the