diff options
author | Antoine du Hamel <duhamelantoine1995@gmail.com> | 2020-09-17 19:53:37 +0300 |
---|---|---|
committer | Rich Trott <rtrott@gmail.com> | 2020-10-01 16:19:25 +0300 |
commit | 57f1e3224e522f9a6795e42e0332fc36f8befb2a (patch) | |
tree | 5df861a4f4dd03ca31f10abdd8e0f7cc681bbfd5 | |
parent | ecf5060a42a5cd073ed4200e80afae1a79178bba (diff) |
doc: sort md references in ASCII order
Refs: https://github.com/nodejs/node/pull/35244
PR-URL: https://github.com/nodejs/node/pull/35191
Fixes: https://github.com/nodejs/node/issues/35189
Reviewed-By: Derek Lewis <DerekNonGeneric@inf.is>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
40 files changed, 227 insertions, 227 deletions
diff --git a/doc/api/addons.md b/doc/api/addons.md index aa71f8726f2..b3402a7bf42 100644 --- a/doc/api/addons.md +++ b/doc/api/addons.md @@ -1356,11 +1356,11 @@ console.log(result); // Prints: 30 ``` -[`Worker`]: worker_threads.md#worker_threads_class_worker [Electron]: https://electronjs.org/ [Embedder's Guide]: https://github.com/v8/v8/wiki/Embedder's%20Guide [Linking to libraries included with Node.js]: #addons_linking_to_libraries_included_with_node_js [Native Abstractions for Node.js]: https://github.com/nodejs/nan +[`Worker`]: worker_threads.md#worker_threads_class_worker [bindings]: https://github.com/TooTallNate/node-bindings [download]: https://github.com/nodejs/node-addon-examples [examples]: https://github.com/nodejs/nan/tree/master/examples/ diff --git a/doc/api/assert.md b/doc/api/assert.md index 07dc5f1a1b8..77456b61481 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -1562,6 +1562,11 @@ assert.throws(throwingFirst, /Second$/); Due to the confusing error-prone notation, avoid a string as the second argument. +[Abstract Equality Comparison]: https://tc39.github.io/ecma262/#sec-abstract-equality-comparison +[Object wrappers]: https://developer.mozilla.org/en-US/docs/Glossary/Primitive#Primitive_wrapper_objects_in_JavaScript +[Object.prototype.toString()]: https://tc39.github.io/ecma262/#sec-object.prototype.tostring +[SameValue Comparison]: https://tc39.github.io/ecma262/#sec-samevalue +[Strict Equality Comparison]: https://tc39.github.io/ecma262/#sec-strict-equality-comparison [`AssertionError`]: #assert_class_assert_assertionerror [`Class`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes [`ERR_INVALID_RETURN_VALUE`]: errors.md#errors_err_invalid_return_value @@ -1591,10 +1596,5 @@ argument. [`tracker.calls()`]: #assert_tracker_calls_fn_exact [`tracker.verify()`]: #assert_tracker_verify [strict assertion mode]: #assert_strict_assertion_mode -[Abstract Equality Comparison]: https://tc39.github.io/ecma262/#sec-abstract-equality-comparison -[Object wrappers]: https://developer.mozilla.org/en-US/docs/Glossary/Primitive#Primitive_wrapper_objects_in_JavaScript -[Object.prototype.toString()]: https://tc39.github.io/ecma262/#sec-object.prototype.tostring -[SameValue Comparison]: https://tc39.github.io/ecma262/#sec-samevalue -[Strict Equality Comparison]: https://tc39.github.io/ecma262/#sec-strict-equality-comparison [enumerable "own" properties]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Enumerability_and_ownership_of_properties [prototype-spec]: https://tc39.github.io/ecma262/#sec-ordinary-object-internal-methods-and-internal-slots diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md index c1fe2facc9a..da000ae845c 100644 --- a/doc/api/async_hooks.md +++ b/doc/api/async_hooks.md @@ -1183,6 +1183,8 @@ If you need to keep using callback-based API, or your code assumes a custom thenable implementation, use the [`AsyncResource`][] class to associate the asynchronous operation with the correct execution context. +[Hook Callbacks]: #async_hooks_hook_callbacks +[PromiseHooks]: https://docs.google.com/document/d/1rda3yKGHimKIhg5YeoAmCOtyURgsbTH_qaYR79FELlk/edit [`AsyncResource`]: #async_hooks_class_asyncresource [`after` callback]: #async_hooks_after_asyncid [`before` callback]: #async_hooks_before_asyncid @@ -1190,9 +1192,7 @@ to associate the asynchronous operation with the correct execution context. [`init` callback]: #async_hooks_init_asyncid_type_triggerasyncid_resource [`promiseResolve` callback]: #async_hooks_promiseresolve_asyncid [`EventEmitter`]: events.md#events_class_eventemitter -[Hook Callbacks]: #async_hooks_hook_callbacks -[PromiseHooks]: https://docs.google.com/document/d/1rda3yKGHimKIhg5YeoAmCOtyURgsbTH_qaYR79FELlk/edit [`Stream`]: stream.md#stream_stream [`Worker`]: worker_threads.md#worker_threads_class_worker -[promise execution tracking]: #async_hooks_promise_execution_tracking [`util.promisify()`]: util.md#util_util_promisify_original +[promise execution tracking]: #async_hooks_promise_execution_tracking diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 7981b9f93af..2e13cec0244 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -3274,7 +3274,12 @@ While there are clear performance advantages to using [`Buffer.allocUnsafe()`][], extra care *must* be taken in order to avoid introducing security vulnerabilities into an application. +[ASCII]: https://en.wikipedia.org/wiki/ASCII +[Base64]: https://en.wikipedia.org/wiki/Base64 +[ISO-8859-1]: https://en.wikipedia.org/wiki/ISO-8859-1 [RFC 4648, Section 5]: https://tools.ietf.org/html/rfc4648#section-5 +[UTF-16]: https://en.wikipedia.org/wiki/UTF-16 +[UTF-8]: https://en.wikipedia.org/wiki/UTF-8 [WHATWG Encoding Standard]: https://encoding.spec.whatwg.org/ [`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer [`Buffer.alloc()`]: #buffer_static_method_buffer_alloc_size_fill_encoding @@ -3286,18 +3291,18 @@ introducing security vulnerabilities into an application. [`Buffer.from(string)`]: #buffer_static_method_buffer_from_string_encoding [`Buffer.poolSize`]: #buffer_class_property_buffer_poolsize [`DataView`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView -[`ERR_INVALID_BUFFER_SIZE`]: errors.md#ERR_INVALID_BUFFER_SIZE [`ERR_INVALID_ARG_VALUE`]: errors.md#ERR_INVALID_ARG_VALUE +[`ERR_INVALID_BUFFER_SIZE`]: errors.md#ERR_INVALID_BUFFER_SIZE [`ERR_OUT_OF_RANGE`]: errors.md#ERR_OUT_OF_RANGE [`JSON.stringify()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify [`SharedArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer [`String#indexOf()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/indexOf [`String#lastIndexOf()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/lastIndexOf [`String.prototype.length`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/length -[`TypedArray.from()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/from [`TypedArray#set()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/set [`TypedArray#slice()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/slice [`TypedArray#subarray()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/subarray +[`TypedArray.from()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/from [`TypedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray [`Uint8Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array [`buf.buffer`]: #buffer_buf_buffer @@ -3314,11 +3319,6 @@ introducing security vulnerabilities into an application. [`buffer.constants.MAX_STRING_LENGTH`]: #buffer_buffer_constants_max_string_length [`buffer.kMaxLength`]: #buffer_buffer_kmaxlength [`util.inspect()`]: util.md#util_util_inspect_object_options -[ASCII]: https://en.wikipedia.org/wiki/ASCII -[Base64]: https://en.wikipedia.org/wiki/Base64 -[ISO-8859-1]: https://en.wikipedia.org/wiki/ISO-8859-1 -[UTF-8]: https://en.wikipedia.org/wiki/UTF-8 -[UTF-16]: https://en.wikipedia.org/wiki/UTF-16 [binary strings]: https://developer.mozilla.org/en-US/docs/Web/API/DOMString/Binary [endianness]: https://en.wikipedia.org/wiki/Endianness [iterator]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols diff --git a/doc/api/child_process.md b/doc/api/child_process.md index dd0a6a51d32..c180176353d 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -1583,6 +1583,9 @@ Therefore, this feature requires opting in by setting the or [`child_process.fork()`][]. [Advanced serialization]: #child_process_advanced_serialization +[Default Windows shell]: #child_process_default_windows_shell +[HTML structured clone algorithm]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm +[Shell requirements]: #child_process_shell_requirements [`'disconnect'`]: process.md#process_event_disconnect [`'error'`]: #child_process_event_error [`'exit'`]: #child_process_event_exit @@ -1615,8 +1618,5 @@ or [`child_process.fork()`][]. [`subprocess.stdio`]: #child_process_subprocess_stdio [`subprocess.stdout`]: #child_process_subprocess_stdout [`util.promisify()`]: util.md#util_util_promisify_original -[Default Windows shell]: #child_process_default_windows_shell -[HTML structured clone algorithm]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm -[Shell requirements]: #child_process_shell_requirements [synchronous counterparts]: #child_process_synchronous_process_creation [v8.serdes]: v8.md#v8_serialization_api diff --git a/doc/api/cluster.md b/doc/api/cluster.md index 461b490044e..0b3586d10cd 100644 --- a/doc/api/cluster.md +++ b/doc/api/cluster.md @@ -873,6 +873,8 @@ socket.on('data', (id) => { }); ``` +[Advanced serialization for `child_process`]: child_process.md#child_process_advanced_serialization +[Child Process module]: child_process.md#child_process_child_process_fork_modulepath_args_options [`.fork()`]: #cluster_cluster_fork_env [`.setupMaster()`]: #cluster_cluster_setupmaster_settings [`ChildProcess.send()`]: child_process.md#child_process_subprocess_send_message_sendhandle_options_callback @@ -885,5 +887,3 @@ socket.on('data', (id) => { [`process` event: `'message'`]: process.md#process_event_message [`server.close()`]: net.md#net_event_close [`worker.exitedAfterDisconnect`]: #cluster_worker_exitedafterdisconnect -[Advanced serialization for `child_process`]: child_process.md#child_process_advanced_serialization -[Child Process module]: child_process.md#child_process_child_process_fork_modulepath_args_options diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 01d1f8a0816..acc624942ae 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -3552,6 +3552,23 @@ See the [list of SSL OP Flags][] for details. </tr> </table> +[AEAD algorithms]: https://en.wikipedia.org/wiki/Authenticated_encryption +[CCM mode]: #crypto_ccm_mode +[Caveats]: #crypto_support_for_weak_or_compromised_algorithms +[Crypto constants]: #crypto_crypto_constants_1 +[HTML 5.2]: https://www.w3.org/TR/html52/changes.html#features-removed +[HTML5's `keygen` element]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/keygen +[NIST SP 800-131A]: https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-131Ar1.pdf +[NIST SP 800-132]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf +[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf +[Nonce-Disrespecting Adversaries]: https://github.com/nonce-disrespect/nonce-disrespect +[OpenSSL's SPKAC implementation]: https://www.openssl.org/docs/man1.1.0/apps/openssl-spkac.html +[RFC 1421]: https://www.rfc-editor.org/rfc/rfc1421.txt +[RFC 2412]: https://www.rfc-editor.org/rfc/rfc2412.txt +[RFC 3526]: https://www.rfc-editor.org/rfc/rfc3526.txt +[RFC 3610]: https://www.rfc-editor.org/rfc/rfc3610.txt +[RFC 4055]: https://www.rfc-editor.org/rfc/rfc4055.txt +[RFC 5208]: https://www.rfc-editor.org/rfc/rfc5208.txt [`Buffer`]: buffer.md [`EVP_BytesToKey`]: https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html [`KeyObject`]: #crypto_class_keyobject @@ -3602,27 +3619,10 @@ See the [list of SSL OP Flags][] for details. [`util.promisify()`]: util.md#util_util_promisify_original [`verify.update()`]: #crypto_verify_update_data_inputencoding [`verify.verify()`]: #crypto_verify_verify_object_signature_signatureencoding -[AEAD algorithms]: https://en.wikipedia.org/wiki/Authenticated_encryption -[CCM mode]: #crypto_ccm_mode -[Caveats]: #crypto_support_for_weak_or_compromised_algorithms -[Crypto constants]: #crypto_crypto_constants_1 -[HTML 5.2]: https://www.w3.org/TR/html52/changes.html#features-removed -[HTML5's `keygen` element]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/keygen -[NIST SP 800-131A]: https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-131Ar1.pdf -[NIST SP 800-132]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf -[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf -[modulo bias]: https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle#Modulo_bias -[Nonce-Disrespecting Adversaries]: https://github.com/nonce-disrespect/nonce-disrespect -[OpenSSL's SPKAC implementation]: https://www.openssl.org/docs/man1.1.0/apps/openssl-spkac.html -[RFC 1421]: https://www.rfc-editor.org/rfc/rfc1421.txt -[RFC 2412]: https://www.rfc-editor.org/rfc/rfc2412.txt -[RFC 3526]: https://www.rfc-editor.org/rfc/rfc3526.txt -[RFC 3610]: https://www.rfc-editor.org/rfc/rfc3610.txt -[RFC 4055]: https://www.rfc-editor.org/rfc/rfc4055.txt -[RFC 5208]: https://www.rfc-editor.org/rfc/rfc5208.txt [encoding]: buffer.md#buffer_buffers_and_character_encodings [initialization vector]: https://en.wikipedia.org/wiki/Initialization_vector [list of SSL OP Flags]: https://wiki.openssl.org/index.php/List_of_SSL_OP_Flags#Table_of_Options +[modulo bias]: https://en.wikipedia.org/wiki/Fisher%E2%80%93Yates_shuffle#Modulo_bias [safe integers]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isSafeInteger [scrypt]: https://en.wikipedia.org/wiki/Scrypt [stream]: stream.md diff --git a/doc/api/debugger.md b/doc/api/debugger.md index 2579a72b97a..08664ff9677 100644 --- a/doc/api/debugger.md +++ b/doc/api/debugger.md @@ -201,5 +201,5 @@ Chrome DevTools doesn't support debugging [worker threads][] yet. [Chrome DevTools Protocol]: https://chromedevtools.github.io/devtools-protocol/ [V8 Inspector]: #debugger_v8_inspector_integration_for_node_js -[worker threads]: worker_threads.md [ndb]: https://github.com/GoogleChromeLabs/ndb/ +[worker threads]: worker_threads.md diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index d93493f4199..8c4ed95069c 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -2650,6 +2650,10 @@ Type: Documentation-only The [`crypto.Certificate()` constructor][] is deprecated. Use [static methods of `crypto.Certificate()`][] instead. +[Legacy URL API]: url.md#url_legacy_url_api +[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf +[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3 +[WHATWG URL API]: url.md#url_the_whatwg_url_api [`--pending-deprecation`]: cli.md#cli_pending_deprecation [`--throw-deprecation`]: cli.md#cli_throw_deprecation [`--unhandled-rejections`]: cli.md#cli_unhandled_rejections_mode @@ -2710,18 +2714,18 @@ The [`crypto.Certificate()` constructor][] is deprecated. Use [`process.env`]: process.md#process_process_env [`process.mainModule`]: process.md#process_process_mainmodule [`punycode`]: punycode.md -[`require.extensions`]: modules.md#modules_require_extensions -[`require.main`]: modules.md#modules_accessing_the_main_module [`request.abort()`]: http.md#http_request_abort -[`request.socket`]: http.md#http_request_socket [`request.connection`]: http.md#http_request_connection [`request.destroy()`]: http.md#http_request_destroy_error -[`response.socket`]: http.md#http_response_socket +[`request.socket`]: http.md#http_request_socket +[`require.extensions`]: modules.md#modules_require_extensions +[`require.main`]: modules.md#modules_accessing_the_main_module [`response.connection`]: http.md#http_response_connection [`response.end()`]: http.md#http_response_end_data_encoding_callback [`response.finished`]: http.md#http_response_finished -[`response.writableFinished`]: http.md#http_response_writablefinished +[`response.socket`]: http.md#http_response_socket [`response.writableEnded`]: http.md#http_response_writableended +[`response.writableFinished`]: http.md#http_response_writablefinished [`script.createCachedData()`]: vm.md#vm_script_createcacheddata [`setInterval()`]: timers.md#timers_setinterval_callback_delay_args [`setTimeout()`]: timers.md#timers_settimeout_callback_delay_args @@ -2764,10 +2768,6 @@ The [`crypto.Certificate()` constructor][] is deprecated. Use [`worker.terminate()`]: worker_threads.md#worker_threads_worker_terminate [`writable.writableLength`]: stream.md#stream_writable_writablelength [`zlib.bytesWritten`]: zlib.md#zlib_zlib_byteswritten -[Legacy URL API]: url.md#url_legacy_url_api -[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf -[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3 -[WHATWG URL API]: url.md#url_the_whatwg_url_api [alloc]: buffer.md#buffer_static_method_buffer_alloc_size_fill_encoding [alloc_unsafe_size]: buffer.md#buffer_static_method_buffer_allocunsafe_size [from_arraybuffer]: buffer.md#buffer_static_method_buffer_from_arraybuffer_byteoffset_length diff --git a/doc/api/dgram.md b/doc/api/dgram.md index e1c5ace6b05..9c289b3fb7c 100644 --- a/doc/api/dgram.md +++ b/doc/api/dgram.md @@ -785,6 +785,8 @@ interfaces" address on a random port (it does the right thing for both `udp4` and `udp6` sockets). The bound address and port can be retrieved using [`socket.address().address`][] and [`socket.address().port`][]. +[IPv6 Zone Indices]: https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses +[RFC 4007]: https://tools.ietf.org/html/rfc4007 [`'close'`]: #dgram_event_close [`ERR_SOCKET_BAD_PORT`]: errors.md#errors_err_socket_bad_port [`ERR_SOCKET_BUFFER_SIZE`]: errors.md#errors_err_socket_buffer_size @@ -800,6 +802,4 @@ and `udp6` sockets). The bound address and port can be retrieved using [`socket.address().address`]: #dgram_socket_address [`socket.address().port`]: #dgram_socket_address [`socket.bind()`]: #dgram_socket_bind_port_address_callback -[IPv6 Zone Indices]: https://en.wikipedia.org/wiki/IPv6_address#Scoped_literal_IPv6_addresses -[RFC 4007]: https://tools.ietf.org/html/rfc4007 [byte length]: buffer.md#buffer_static_method_buffer_bytelength_string_encoding diff --git a/doc/api/dns.md b/doc/api/dns.md index e8ab1c917bb..62eee6f90b0 100644 --- a/doc/api/dns.md +++ b/doc/api/dns.md @@ -1160,6 +1160,11 @@ processing that happens on libuv's threadpool that [`dns.lookup()`][] can have. They do not use the same set of configuration files than what [`dns.lookup()`][] uses. For instance, _they do not use the configuration from `/etc/hosts`_. +[DNS error codes]: #dns_error_codes +[Domain Name System (DNS)]: https://en.wikipedia.org/wiki/Domain_Name_System +[Implementation considerations section]: #dns_implementation_considerations +[RFC 5952]: https://tools.ietf.org/html/rfc5952#section-6 +[RFC 8482]: https://tools.ietf.org/html/rfc8482 [`Error`]: errors.md#errors_class_error [`UV_THREADPOOL_SIZE`]: cli.md#cli_uv_threadpool_size_size [`dgram.createSocket()`]: dgram.md#dgram_dgram_createsocket_options_callback @@ -1197,9 +1202,4 @@ uses. For instance, _they do not use the configuration from `/etc/hosts`_. [`dnsPromises.setServers()`]: #dns_dnspromises_setservers_servers [`socket.connect()`]: net.md#net_socket_connect_options_connectlistener [`util.promisify()`]: util.md#util_util_promisify_original -[DNS error codes]: #dns_error_codes -[Domain Name System (DNS)]: https://en.wikipedia.org/wiki/Domain_Name_System -[Implementation considerations section]: #dns_implementation_considerations -[RFC 5952]: https://tools.ietf.org/html/rfc5952#section-6 -[RFC 8482]: https://tools.ietf.org/html/rfc8482 [supported `getaddrinfo` flags]: #dns_supported_getaddrinfo_flags diff --git a/doc/api/documentation.md b/doc/api/documentation.md index bdc3466152c..979d85ef0a3 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -60,7 +60,7 @@ Most Unix system calls have Windows analogues. Still, behavior differences may be unavoidable. [Semantic Versioning]: https://semver.org/ +[V8 JavaScript engine]: https://v8.dev/ [the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md [the issue tracker]: https://github.com/nodejs/node/issues/new -[V8 JavaScript engine]: https://v8.dev/ [warning]: process.md#process_event_warning diff --git a/doc/api/embedding.md b/doc/api/embedding.md index d18b3d91411..f27b87821bd 100644 --- a/doc/api/embedding.md +++ b/doc/api/embedding.md @@ -220,8 +220,8 @@ int RunNodeInstance(MultiIsolatePlatform* platform, } ``` -[`process.memoryUsage()`]: process.md#process_process_memoryusage [CLI options]: cli.md +[`process.memoryUsage()`]: process.md#process_process_memoryusage [deprecation policy]: deprecations.md [embedtest.cc]: https://github.com/nodejs/node/blob/master/test/embedding/embedtest.cc [src/node.h]: https://github.com/nodejs/node/blob/master/src/node.h diff --git a/doc/api/errors.md b/doc/api/errors.md index 2816323c1df..814a6e5b16a 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -2580,6 +2580,16 @@ removed: v10.0.0 Used when an attempt is made to use a `zlib` object after it has already been closed. +[ES Module]: esm.md +[ICU]: intl.md#intl_internationalization_support +[Node.js error codes]: #nodejs-error-codes +[RFC 7230 Section 3]: https://tools.ietf.org/html/rfc7230#section-3 +[Subresource Integrity specification]: https://www.w3.org/TR/SRI/#the-integrity-attribute +[V8's stack trace API]: https://github.com/v8/v8/wiki/Stack-Trace-API +[WHATWG Supported Encodings]: util.md#util_whatwg_supported_encodings +[WHATWG URL API]: url.md#url_the_whatwg_url_api +[`"exports"`]: packages.md#packages_exports +[`"imports"`]: packages.md#packages_imports [`'uncaughtException'`]: process.md#process_event_uncaughtexception [`--disable-proto=throw`]: cli.md#cli_disable_proto_mode [`--force-fips`]: cli.md#cli_force_fips @@ -2619,6 +2629,7 @@ closed. [`net`]: net.md [`new URL(input)`]: url.md#url_new_url_input_base [`new URLSearchParams(iterable)`]: url.md#url_new_urlsearchparams_iterable +[`package.json`]: packages.md#packages_node_js_package_json_field_definitions [`postMessage()`]: worker_threads.md#worker_threads_port_postmessage_value_transferlist [`process.on('exit')`]: process.md#Event:-`'exit'` [`process.send()`]: process.md#process_process_send_message_sendhandle_options_callback @@ -2637,25 +2648,14 @@ closed. [`subprocess.send()`]: child_process.md#child_process_subprocess_send_message_sendhandle_options_callback [`util.getSystemErrorName(error.errno)`]: util.md#util_util_getsystemerrorname_err [`zlib`]: zlib.md -[ES Module]: esm.md -[ICU]: intl.md#intl_internationalization_support -[Node.js error codes]: #nodejs-error-codes -[V8's stack trace API]: https://github.com/v8/v8/wiki/Stack-Trace-API -[WHATWG Supported Encodings]: util.md#util_whatwg_supported_encodings -[WHATWG URL API]: url.md#url_the_whatwg_url_api [crypto digest algorithm]: crypto.md#crypto_crypto_gethashes +[define a custom subpath]: packages.md#packages_subpath_exports [domains]: domain.md [event emitter-based]: events.md#events_class_eventemitter -[`package.json`]: packages.md#packages_node_js_package_json_field_definitions -[`"exports"`]: packages.md#packages_exports [file descriptors]: https://en.wikipedia.org/wiki/File_descriptor [policy]: policy.md -[RFC 7230 Section 3]: https://tools.ietf.org/html/rfc7230#section-3 +[self-reference a package using its name]: packages.md#packages_self_referencing_a_package_using_its_name [stream-based]: stream.md [syscall]: https://man7.org/linux/man-pages/man2/syscalls.2.html -[Subresource Integrity specification]: https://www.w3.org/TR/SRI/#the-integrity-attribute [try-catch]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/try...catch [vm]: vm.md -[self-reference a package using its name]: packages.md#packages_self_referencing_a_package_using_its_name -[define a custom subpath]: packages.md#packages_subpath_exports -[`"imports"`]: packages.md#packages_imports diff --git a/doc/api/esm.md b/doc/api/esm.md index c24ed61b9bc..38ce8275104 100644 --- a/doc/api/esm.md +++ b/doc/api/esm.md @@ -1229,15 +1229,24 @@ success! ``` <!-- Note: The cjs-module-lexer link should be kept in-sync with the deps version --> +[6.1.7 Array Index]: https://tc39.es/ecma262/#integer-index [CommonJS]: modules.md [Conditional exports]: packages.md#packages_conditional_exports +[Core modules]: modules.md#modules_core_modules [Dynamic `import()`]: https://wiki.developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import#Dynamic_Imports -[ECMAScript-modules implementation]: https://github.com/nodejs/modules/blob/master/doc/plan-for-new-modules-implementation.md [ECMAScript Top-Level `await` proposal]: https://github.com/tc39/proposal-top-level-await/ +[ECMAScript-modules implementation]: https://github.com/nodejs/modules/blob/master/doc/plan-for-new-modules-implementation.md [ES Module Integration Proposal for Web Assembly]: https://github.com/webassembly/esm-integration [Node.js EP for ES Modules]: https://github.com/nodejs/node-eps/blob/master/002-es-modules.md [Terminology]: #esm_terminology +[Top-Level Await]: https://github.com/tc39/proposal-top-level-await [WHATWG JSON modules specification]: https://html.spec.whatwg.org/#creating-a-json-module-script +[`"exports"`]: packages.md#packages_exports +[`"type"`]: packages.md#packages_type +[`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer +[`SharedArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer +[`TypedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray +[`Uint8Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array [`data:` URLs]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs [`export`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export [`import()`]: #esm_import_expressions @@ -1245,20 +1254,11 @@ success! [`import`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import [`module.createRequire()`]: module.md#module_module_createrequire_filename [`module.syncBuiltinESMExports()`]: module.md#module_module_syncbuiltinesmexports +[`package.json`]: packages.md#packages_node_js_package_json_field_definitions [`transformSource` hook]: #esm_transformsource_source_context_defaulttransformsource -[`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer -[`SharedArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer [`string`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String -[`TypedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray -[`Uint8Array`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array [`util.TextDecoder`]: util.md#util_class_util_textdecoder [cjs-module-lexer]: https://github.com/guybedford/cjs-module-lexer/tree/0.3.1 [special scheme]: https://url.spec.whatwg.org/#special-scheme [the official standard format]: https://tc39.github.io/ecma262/#sec-modules [transpiler loader example]: #esm_transpiler_loader -[6.1.7 Array Index]: https://tc39.es/ecma262/#integer-index -[Top-Level Await]: https://github.com/tc39/proposal-top-level-await -[Core modules]: modules.md#modules_core_modules -[`package.json`]: packages.md#packages_node_js_package_json_field_definitions -[`"exports"`]: packages.md#packages_exports -[`"type"`]: packages.md#packages_type diff --git a/doc/api/events.md b/doc/api/events.md index 9d46d8a8dd9..7ace75fa65d 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -1528,13 +1528,13 @@ to the `EventTarget`. [WHATWG-EventTarget]: https://dom.spec.whatwg.org/#interface-eventtarget [`--trace-warnings`]: cli.md#cli_trace_warnings [`EventEmitter.defaultMaxListeners`]: #events_eventemitter_defaultmaxlisteners +[`EventTarget` Web API]: https://dom.spec.whatwg.org/#eventtarget +[`EventTarget` error handling]: #events_eventtarget_error_handling +[`Event` Web API]: https://dom.spec.whatwg.org/#event [`domain`]: domain.md [`emitter.listenerCount()`]: #events_emitter_listenercount_eventname [`emitter.removeListener()`]: #events_emitter_removelistener_eventname_listener [`emitter.setMaxListeners(n)`]: #events_emitter_setmaxlisteners_n -[`Event` Web API]: https://dom.spec.whatwg.org/#event -[`EventTarget` error handling]: #events_eventtarget_error_handling -[`EventTarget` Web API]: https://dom.spec.whatwg.org/#eventtarget [`fs.ReadStream`]: fs.md#fs_class_fs_readstream [`net.Server`]: net.md#net_class_net_server [`process.on('warning')`]: process.md#process_event_warning diff --git a/doc/api/fs.md b/doc/api/fs.md index cef7d608f3d..fa369c12583 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -5960,6 +5960,17 @@ through `fs.open()` or `fs.writeFile()` or `fsPromises.open()`) will fail with A call to `fs.ftruncate()` or `filehandle.truncate()` can be used to reset the file contents. +[Caveats]: #fs_caveats +[Common System Errors]: errors.md#errors_common_system_errors +[FS constants]: #fs_fs_constants_1 +[File access constants]: #fs_file_access_constants +[MDN-Date]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date +[MDN-Number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type +[MSDN-Rel-Path]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#fully-qualified-vs-relative-paths +[MSDN-Using-Streams]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/using-streams +[Naming Files, Paths, and Namespaces]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file +[Readable Stream]: stream.md#stream_class_stream_readable +[Writable Stream]: stream.md#stream_class_stream_writable [`AHAFS`]: https://www.ibm.com/developerworks/aix/library/au-aix_event_infrastructure/ [`Buffer.byteLength`]: buffer.md#buffer_static_method_buffer_bytelength_string_encoding [`Buffer`]: buffer.md#buffer_buffer @@ -5967,7 +5978,6 @@ the file contents. [`Number.MAX_SAFE_INTEGER`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER [`ReadDirectoryChangesW`]: https://docs.microsoft.com/en-us/windows/desktop/api/winbase/nf-winbase-readdirectorychangesw [`ReadStream`]: #fs_class_fs_readstream -[Readable Stream]: stream.md#stream_class_stream_readable [`URL`]: url.md#url_the_whatwg_url_api [`UV_THREADPOOL_SIZE`]: cli.md#cli_uv_threadpool_size_size [`WriteStream`]: #fs_class_fs_writestream @@ -6018,17 +6028,7 @@ the file contents. [`net.Socket`]: net.md#net_class_net_socket [`stat()`]: fs.md#fs_fs_stat_path_options_callback [`util.promisify()`]: util.md#util_util_promisify_original -[Caveats]: #fs_caveats -[Common System Errors]: errors.md#errors_common_system_errors -[FS constants]: #fs_fs_constants_1 -[File access constants]: #fs_file_access_constants -[MDN-Date]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date -[MDN-Number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type -[MSDN-Rel-Path]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#fully-qualified-vs-relative-paths -[MSDN-Using-Streams]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/using-streams -[Naming Files, Paths, and Namespaces]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file [bigints]: https://tc39.github.io/proposal-bigint [chcp]: https://ss64.com/nt/chcp.html [inode]: https://en.wikipedia.org/wiki/Inode [support of file system `flags`]: #fs_file_system_flags -[Writable Stream]: stream.md#stream_class_stream_writable diff --git a/doc/api/http.md b/doc/api/http.md index 9d1d5b528ce..3e140dab961 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -2708,7 +2708,7 @@ try { [`socket.setTimeout()`]: net.md#net_socket_settimeout_timeout_callback [`socket.unref()`]: net.md#net_socket_unref [`url.parse()`]: url.md#url_url_parse_urlstring_parsequerystring_slashesdenotehost +[`writable.cork()`]: stream.md#stream_writable_cork [`writable.destroy()`]: stream.md#stream_writable_destroy_error [`writable.destroyed`]: stream.md#stream_writable_destroyed -[`writable.cork()`]: stream.md#stream_writable_cork [`writable.uncork()`]: stream.md#stream_writable_uncork diff --git a/doc/api/http2.md b/doc/api/http2.md index 47ec107024b..bd8e1ced7ff 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -3707,10 +3707,10 @@ you need to implement any fall-back behaviour yourself. [ALPN negotiation]: #http2_alpn_negotiation [Compatibility API]: #http2_compatibility_api [HTTP/1]: http.md +[HTTP/2]: https://tools.ietf.org/html/rfc7540 [HTTP/2 Headers Object]: #http2_headers_object [HTTP/2 Settings Object]: #http2_settings_object [HTTP/2 Unencrypted]: https://http2.github.io/faq/#does-http2-require-encryption -[HTTP/2]: https://tools.ietf.org/html/rfc7540 [HTTPS]: https.md [Performance Observer]: perf_hooks.md [RFC 7838]: https://tools.ietf.org/html/rfc7838 @@ -3736,13 +3736,13 @@ you need to implement any fall-back behaviour yourself. [`http2.createServer()`]: #http2_http2_createserver_options_onrequesthandler [`http2session.close()`]: #http2_http2session_close_callback [`http2stream.pushStream()`]: #http2_http2stream_pushstream_headers_options_callback -[`net.createServer()`]: net.md#net_net_createserver_options_connectionlistener [`net.Server.close()`]: net.md#net_server_close_callback [`net.Socket.bufferSize`]: net.md#net_socket_buffersize [`net.Socket.prototype.ref()`]: net.md#net_socket_ref [`net.Socket.prototype.unref()`]: net.md#net_socket_unref [`net.Socket`]: net.md#net_class_net_socket [`net.connect()`]: net.md#net_net_connect +[`net.createServer()`]: net.md#net_net_createserver_options_connectionlistener [`request.authority`]: #http2_request_authority [`request.socket`]: #http2_request_socket [`request.socket.getPeerCertificate()`]: tls.md#tls_tlssocket_getpeercertificate_detailed diff --git a/doc/api/https.md b/doc/api/https.md index b7f2f2b1e1f..e76a7c9b6a7 100644 --- a/doc/api/https.md +++ b/doc/api/https.md @@ -454,9 +454,10 @@ headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; p ``` [`Agent`]: #https_class_https_agent +[`Session Resumption`]: tls.md#tls_session_resumption [`URL`]: url.md#url_the_whatwg_url_api -[`http.Agent`]: http.md#http_class_http_agent [`http.Agent(options)`]: http.md#http_new_agent_options +[`http.Agent`]: http.md#http_class_http_agent [`http.Server#headersTimeout`]: http.md#http_server_headerstimeout [`http.Server#keepAliveTimeout`]: http.md#http_server_keepalivetimeout [`http.Server#maxHeadersCount`]: http.md#http_server_maxheaderscount @@ -476,5 +477,4 @@ headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; p [`tls.connect()`]: tls.md#tls_tls_connect_options_callback [`tls.createSecureContext()`]: tls.md#tls_tls_createsecurecontext_options [`tls.createServer()`]: tls.md#tls_tls_createserver_options_secureconnectionlistener -[`Session Resumption`]: tls.md#tls_session_resumption [sni wiki]: https://en.wikipedia.org/wiki/Server_Name_Indication diff --git a/doc/api/intl.md b/doc/api/intl.md index 434a06a5dae..3d6132f9dc5 100644 --- a/doc/api/intl.md +++ b/doc/api/intl.md @@ -189,6 +189,13 @@ to be helpful: dedicated to ECMA-402. ["ICU Data"]: http://userguide.icu-project.org/icudata +[BUILDING.md]: https://github.com/nodejs/node/blob/master/BUILDING.md +[ECMA-262]: https://tc39.github.io/ecma262/ +[ECMA-402]: https://tc39.github.io/ecma402/ +[ICU]: http://site.icu-project.org/ +[REPL]: repl.md#repl_repl +[Test262]: https://github.com/tc39/test262/tree/master/test/intl402 +[WHATWG URL parser]: url.md#url_the_whatwg_url_api [`--icu-data-dir`]: cli.md#cli_icu_data_dir_file [`Date.prototype.toLocaleString()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleString [`Intl.DateTimeFormat`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DateTimeFormat @@ -202,13 +209,6 @@ to be helpful: [`String.prototype.toUpperCase()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/toUpperCase [`require('buffer').transcode()`]: buffer.md#buffer_buffer_transcode_source_fromenc_toenc [`require('util').TextDecoder`]: util.md#util_class_util_textdecoder -[BUILDING.md]: https://github.com/nodejs/node/blob/master/BUILDING.md -[ECMA-262]: https://tc39.github.io/ecma262/ -[ECMA-402]: https://tc39.github.io/ecma402/ -[ICU]: http://site.icu-project.org/ -[REPL]: repl.md#repl_repl -[Test262]: https://github.com/tc39/test262/tree/master/test/intl402 -[WHATWG URL parser]: url.md#url_the_whatwg_url_api [btest402]: https://github.com/srl295/btest402 [full-icu]: https://www.npmjs.com/package/full-icu [internationalized domain names]: https://en.wikipedia.org/wiki/Internationalized_domain_name diff --git a/doc/api/modules.md b/doc/api/modules.md index 171f9b978fa..196b6240d71 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -971,19 +971,19 @@ This section was moved to * <a id="modules_sourcemap_payload" href="module.html#module_sourcemap_payload">`sourceMap.payload`</a> * <a id="modules_sourcemap_findentry_linenumber_columnnumber" href="module.html#module_sourcemap_findentry_linenumber_columnnumber">`sourceMap.findEntry(lineNumber, columnNumber)`</a> +[ECMAScript Modules]: esm.md [GLOBAL_FOLDERS]: #modules_loading_from_the_global_folders +[`"main"`]: packages.md#packages_main [`Error`]: errors.md#errors_class_error [`__dirname`]: #modules_dirname [`__filename`]: #modules_filename [`module` object]: #modules_the_module_object [`module.id`]: #modules_module_id [`module.children`]: #modules_module_children +[`package.json`]: packages.md#packages_node_js_package_json_field_definitions [`path.dirname()`]: path.md#path_path_dirname_path -[ECMAScript Modules]: esm.md +[`require.main`]: #modules_require_main [an error]: errors.md#errors_err_require_esm [exports shortcut]: #modules_exports_shortcut [module resolution]: #modules_all_together [native addons]: addons.md -[`require.main`]: #modules_require_main -[`package.json`]: packages.md#packages_node_js_package_json_field_definitions -[`"main"`]: packages.md#packages_main diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 6afd8b7727d..1836e3821d8 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -5890,8 +5890,8 @@ This API may only be called from the main thread. [ABI Stability]: https://nodejs.org/en/docs/guides/abi-stability/ [AppVeyor]: https://www.appveyor.com [C++ Addons]: addons.md -[CMake.js]: https://github.com/cmake-js/cmake-js [CMake]: https://cmake.org +[CMake.js]: https://github.com/cmake-js/cmake-js [ECMAScript Language Specification]: https://tc39.github.io/ecma262/ [Error handling]: #n_api_error_handling [GCC]: https://gcc.gnu.org @@ -5906,28 +5906,28 @@ This API may only be called from the main thread. [Section 19.2]: https://tc39.github.io/ecma262/#sec-function-objects [Section 19.4]: https://tc39.github.io/ecma262/#sec-symbol-objects [Section 20.3]: https://tc39.github.io/ecma262/#sec-date-objects -[Section 22.1.4.1]: https://tc39.github.io/ecma262/#sec-properties-of-array-instances-length [Section 22.1]: https://tc39.github.io/ecma262/#sec-array-objects +[Section 22.1.4.1]: https://tc39.github.io/ecma262/#sec-properties-of-array-instances-length [Section 22.2]: https://tc39.github.io/ecma262/#sec-typedarray-objects -[Section 24.1.1.3]: https://tc39.es/ecma262/#sec-detacharraybuffer [Section 24.1]: https://tc39.github.io/ecma262/#sec-arraybuffer-objects +[Section 24.1.1.2]: https://tc39.es/ecma262/#sec-isdetachedbuffer +[Section 24.1.1.3]: https://tc39.es/ecma262/#sec-detacharraybuffer [Section 24.3]: https://tc39.github.io/ecma262/#sec-dataview-objects [Section 25.4]: https://tc39.github.io/ecma262/#sec-promise-objects +[Section 6]: https://tc39.github.io/ecma262/#sec-ecmascript-data-types-and-values +[Section 6.1]: https://tc39.github.io/ecma262/#sec-ecmascript-language-types [Section 6.1.4]: https://tc39.github.io/ecma262/#sec-ecmascript-language-types-string-type [Section 6.1.6]: https://tc39.github.io/ecma262/#sec-ecmascript-language-types-number-type -[Section 6.1.7.1]: https://tc39.github.io/ecma262/#table-2 [Section 6.1.7]: https://tc39.github.io/ecma262/#sec-object-type -[Section 6.1]: https://tc39.github.io/ecma262/#sec-ecmascript-language-types -[Section 6]: https://tc39.github.io/ecma262/#sec-ecmascript-data-types-and-values +[Section 6.1.7.1]: https://tc39.github.io/ecma262/#table-2 +[Section 7]: https://tc39.github.io/ecma262/#sec-abstract-operations [Section 7.1.13]: https://tc39.github.io/ecma262/#sec-toobject [Section 7.1.2]: https://tc39.github.io/ecma262/#sec-toboolean [Section 7.1.3]: https://tc39.github.io/ecma262/#sec-tonumber [Section 7.2.14]: https://tc39.github.io/ecma262/#sec-strict-equality-comparison [Section 7.2.2]: https://tc39.github.io/ecma262/#sec-isarray -[Section 7]: https://tc39.github.io/ecma262/#sec-abstract-operations [Section 8.7]: https://tc39.es/ecma262/#sec-agents [Section 9.1.6]: https://tc39.github.io/ecma262/#sec-ordinary-object-internal-methods-and-internal-slots-defineownproperty-p-desc -[Section 24.1.1.2]: https://tc39.es/ecma262/#sec-isdetachedbuffer [Travis CI]: https://travis-ci.org [Visual Studio]: https://visualstudio.microsoft.com [Working with JavaScript properties]: #n_api_working_with_javascript_properties diff --git a/doc/api/net.md b/doc/api/net.md index f581de0c8a1..d23b8c0c91c 100644 --- a/doc/api/net.md +++ b/doc/api/net.md @@ -1320,8 +1320,8 @@ Returns `true` if input is a version 6 IP address, otherwise returns `false`. [IPC]: #net_ipc_support [Identifying paths for IPC connections]: #net_identifying_paths_for_ipc_connections -[Readable Stream]: stream.md#stream_class_stream_readable [QUIC documentation]: quic.md +[Readable Stream]: stream.md#stream_class_stream_readable [`'close'`]: #net_event_close [`'connect'`]: #net_event_connect [`'connection'`]: #net_event_connection @@ -1333,8 +1333,8 @@ Returns `true` if input is a version 6 IP address, otherwise returns `false`. [`'timeout'`]: #net_event_timeout [`EventEmitter`]: events.md#events_class_eventemitter [`child_process.fork()`]: child_process.md#child_process_child_process_fork_modulepath_args_options -[`dns.lookup()` hints]: dns.md#dns_supported_getaddrinfo_flags [`dns.lookup()`]: dns.md#dns_dns_lookup_hostname_options_callback +[`dns.lookup()` hints]: dns.md#dns_supported_getaddrinfo_flags [`net.Server`]: #net_class_net_server [`net.Socket`]: #net_class_net_socket [`net.connect()`]: #net_net_connect @@ -1366,10 +1366,10 @@ Returns `true` if input is a version 6 IP address, otherwise returns `false`. [`socket.setEncoding()`]: #net_socket_setencoding_encoding [`socket.setTimeout()`]: #net_socket_settimeout_timeout_callback [`socket.setTimeout(timeout)`]: #net_socket_settimeout_timeout_callback -[`writable.writableLength`]: stream.md#stream_writable_writablelength -[`writable.destroyed`]: stream.md#stream_writable_destroyed [`writable.destroy()`]: stream.md#stream_writable_destroy_error +[`writable.destroyed`]: stream.md#stream_writable_destroyed [`writable.end()`]: stream.md#stream_writable_end_chunk_encoding_callback +[`writable.writableLength`]: stream.md#stream_writable_writablelength [half-closed]: https://tools.ietf.org/html/rfc1122 [stream_writable_write]: stream.md#stream_writable_write_chunk_encoding_callback [unspecified IPv4 address]: https://en.wikipedia.org/wiki/0.0.0.0 diff --git a/doc/api/os.md b/doc/api/os.md index 50f64f7d8fa..08a566a27b6 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -1269,9 +1269,9 @@ The following process scheduling constants are exported by </tr> </table> +[Android building]: https://github.com/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os +[EUID]: https://en.wikipedia.org/wiki/User_identifier#Effective_user_ID [`SystemError`]: errors.md#errors_class_systemerror [`process.arch`]: process.md#process_process_arch [`process.platform`]: process.md#process_process_platform [`uname(3)`]: https://linux.die.net/man/3/uname -[Android building]: https://github.com/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os -[EUID]: https://en.wikipedia.org/wiki/User_identifier#Effective_user_ID diff --git a/doc/api/packages.md b/doc/api/packages.md index 5dccc5e3980..338bc22fac1 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -960,17 +960,17 @@ analogous to the exports field. [Babel]: https://babeljs.io/ [Conditional exports]: #packages_conditional_exports [CommonJS]: modules.md -[`ERR_PACKAGE_PATH_NOT_EXPORTED`]: errors.md#errors_err_package_path_not_exported -[ES modules]: esm.md [ES module]: esm.md +[ES modules]: esm.md +[`ERR_PACKAGE_PATH_NOT_EXPORTED`]: errors.md#errors_err_package_path_not_exported [`esm`]: https://github.com/standard-things/esm#readme [`"exports"`]: #packages_exports [`"main"`]: #packages_main [`"name"`]: #packages_name [`"imports"`]: #packages_imports [`"type"`]: #packages_type -[entry points]: #packages_package_entry_points [`package.json`]: #packages_node_js_package_json_field_definitions +[entry points]: #packages_package_entry_points [self-reference]: #packages_self_referencing_a_package_using_its_name [subpath exports]: #packages_subpath_exports [the full specifier path]: esm.md#esm_mandatory_file_extensions diff --git a/doc/api/path.md b/doc/api/path.md index 1193d4ca36a..c26a98e59c9 100644 --- a/doc/api/path.md +++ b/doc/api/path.md @@ -575,10 +575,10 @@ added: v0.11.15 The `path.win32` property provides access to Windows-specific implementations of the `path` methods. +[MSDN-Rel-Path]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#fully-qualified-vs-relative-paths [`TypeError`]: errors.md#errors_class_typeerror [`path.parse()`]: #path_path_parse_path [`path.posix`]: #path_path_posix [`path.sep`]: #path_path_sep [`path.win32`]: #path_path_win32 -[MSDN-Rel-Path]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#fully-qualified-vs-relative-paths [namespace-prefixed path]: https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file#namespaces diff --git a/doc/api/perf_hooks.md b/doc/api/perf_hooks.md index aca7549b245..01e8597a51d 100644 --- a/doc/api/perf_hooks.md +++ b/doc/api/perf_hooks.md @@ -756,13 +756,13 @@ obs.observe({ entryTypes: ['function'], buffered: true }); require('some-module'); ``` -[`'exit'`]: process.md#process_event_exit -[`process.hrtime()`]: process.md#process_process_hrtime_time -[`child_process.spawnSync()`]: child_process.md#child_process_child_process_spawnsync_command_args_options -[`timeOrigin`]: https://w3c.github.io/hr-time/#dom-performance-timeorigin -[`window.performance`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/performance [Async Hooks]: async_hooks.md [High Resolution Time]: https://www.w3.org/TR/hr-time-2 [Performance Timeline]: https://w3c.github.io/performance-timeline/ -[Web Performance APIs]: https://w3c.github.io/perf-timing-primer/ [User Timing]: https://www.w3.org/TR/user-timing/ +[Web Performance APIs]: https://w3c.github.io/perf-timing-primer/ +[`'exit'`]: process.md#process_event_exit +[`child_process.spawnSync()`]: child_process.md#child_process_child_process_spawnsync_command_args_options +[`process.hrtime()`]: process.md#process_process_hrtime_time +[`timeOrigin`]: https://w3c.github.io/hr-time/#dom-performance-timeorigin +[`window.performance`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/performance diff --git a/doc/api/process.md b/doc/api/process.md index 8ef90a58dc8..67397b94979 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -2606,6 +2606,18 @@ cases: For example, signal `SIGABRT` has value `6`, so the expected exit code will be `128` + `6`, or `134`. +[Advanced serialization for `child_process`]: child_process.md#child_process_advanced_serialization +[Android building]: https://github.com/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os +[Child Process]: child_process.md +[Cluster]: cluster.md +[Duplex]: stream.md#stream_duplex_and_transform_streams +[Event Loop]: https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick/#process-nexttick +[LTS]: https://github.com/nodejs/Release +[Readable]: stream.md#stream_readable_streams +[Signal Events]: #process_signal_events +[Stream compatibility]: stream.md#stream_compatibility_with_older_node_js_versions +[TTY]: tty.md#tty_tty +[Writable]: stream.md#stream_writable_streams [`'exit'`]: #process_event_exit [`'message'`]: child_process.md#child_process_event_message [`'uncaughtException'`]: #process_event_uncaughtexception @@ -2617,6 +2629,7 @@ cases: [`Error`]: errors.md#errors_class_error [`EventEmitter`]: events.md#events_class_eventemitter [`NODE_OPTIONS`]: cli.md#cli_node_options_options +[`Promise.race()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/race [`Worker`]: worker_threads.md#worker_threads_class_worker [`console.error()`]: console.md#console_console_error_data_args [`console.log()`]: console.md#console_console_log_data_args @@ -2634,25 +2647,12 @@ cases: [`process.kill()`]: #process_process_kill_pid_signal [`process.setUncaughtExceptionCaptureCallback()`]: process.md#process_process_setuncaughtexceptioncapturecallback_fn [`promise.catch()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/catch -[`Promise.race()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/race +[`readable.read()`]: stream.md#stream_readable_read_size [`require()`]: globals.md#globals_require [`require.main`]: modules.md#modules_accessing_the_main_module [`require.resolve()`]: modules.md#modules_require_resolve_request_options [`subprocess.kill()`]: child_process.md#child_process_subprocess_kill_signal [`v8.setFlagsFromString()`]: v8.md#v8_v8_setflagsfromstring_flags -[Advanced serialization for `child_process`]: child_process.md#child_process_advanced_serialization -[Android building]: https://github.com/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os -[Child Process]: child_process.md -[Cluster]: cluster.md -[Duplex]: stream.md#stream_duplex_and_transform_streams -[Event Loop]: https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick/#process-nexttick -[LTS]: https://github.com/nodejs/Release -[Readable]: stream.md#stream_readable_streams -[`readable.read()`]: stream.md#stream_readable_read_size -[Signal Events]: #process_signal_events -[Stream compatibility]: stream.md#stream_compatibility_with_older_node_js_versions -[TTY]: tty.md#tty_tty -[Writable]: stream.md#stream_writable_streams [debugger]: debugger.md [note on process I/O]: process.md#process_a_note_on_process_i_o [process.cpuUsage]: #process_process_cpuusage_previousvalue @@ -2661,5 +2661,5 @@ cases: [report documentation]: report.md [terminal raw mode]: tty.md#tty_readstream_setrawmode_mode [uv_rusage_t]: https://docs.libuv.org/en/v1.x/misc.html#c.uv_rusage_t -[wikipedia_minor_fault]: https://en.wikipedia.org/wiki/Page_fault#Minor [wikipedia_major_fault]: https://en.wikipedia.org/wiki/Page_fault#Major +[wikipedia_minor_fault]: https://en.wikipedia.org/wiki/Page_fault#Minor diff --git a/doc/api/quic.md b/doc/api/quic.md index bdd221df697..85451ef849d 100644 --- a/doc/api/quic.md +++ b/doc/api/quic.md @@ -2499,20 +2499,20 @@ server.listen({ }); ``` -[`crypto.getCurves()`]: crypto.md#crypto_crypto_getcurves -[`stream.Readable`]: #stream_class_stream_readable -[`tls.DEFAULT_ECDH_CURVE`]: #tls_tls_default_ecdh_curve -[`tls.getCiphers()`]: tls.md#tls_tls_getciphers [ALPN]: https://tools.ietf.org/html/rfc7301 -[RFC 4007]: https://tools.ietf.org/html/rfc4007 [Certificate Object]: https://nodejs.org/dist/latest-v12.x/docs/api/tls.html#tls_certificate_object -[custom DNS lookup function]: #quic_custom_dns_lookup_functions [Handling client hello]: #quic_handling_client_hello -[modifying the default cipher suite]: tls.md#tls_modifying_the_default_tls_cipher_suite [OCSP requests]: #quic_online_certificate_status_protocol_ocsp [OCSP responses]: #quic_online_certificate_status_protocol_ocsp [OpenSSL Options]: crypto.md#crypto_openssl_options [Perfect Forward Secrecy]: #tls_perfect_forward_secrecy +[RFC 4007]: https://tools.ietf.org/html/rfc4007 +[`crypto.getCurves()`]: crypto.md#crypto_crypto_getcurves +[`stream.Readable`]: #stream_class_stream_readable +[`tls.DEFAULT_ECDH_CURVE`]: #tls_tls_default_ecdh_curve +[`tls.getCiphers()`]: tls.md#tls_tls_getciphers +[custom DNS lookup function]: #quic_custom_dns_lookup_functions +[modifying the default cipher suite]: tls.md#tls_modifying_the_default_tls_cipher_suite [promisified version of `lookup()`]: dns.md#dns_dnspromises_lookup_hostname_options ['qlog']: #quic_quicsession_qlog [qlog standard]: https://tools.ietf.org/id/draft-marx-qlog-event-definitions-quic-h3-00.html diff --git a/doc/api/readline.md b/doc/api/readline.md index f44c9101b8f..2e82fdf91a1 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -865,6 +865,10 @@ const { createInterface } = require('readline'); </tr> </table> +[Readable]: stream.md#stream_readable_streams +[TTY]: tty.md +[TTY keybindings]: #readline_tty_keybindings +[Writable]: stream.md#stream_writable_streams [`'SIGCONT'`]: readline.md#readline_event_sigcont [`'SIGTSTP'`]: readline.md#readline_event_sigtstp [`'line'`]: #readline_event_line @@ -872,8 +876,4 @@ const { createInterface } = require('readline'); [`process.stdin`]: process.md#process_process_stdin [`process.stdout`]: process.md#process_process_stdout [`rl.close()`]: #readline_rl_close -[Readable]: stream.md#stream_readable_streams -[TTY]: tty.md -[TTY keybindings]: #readline_tty_keybindings -[Writable]: stream.md#stream_writable_streams [reading files]: #readline_example_read_file_stream_line_by_line diff --git a/doc/api/report.md b/doc/api/report.md index cffa288d9f7..b62de913be2 100644 --- a/doc/api/report.md +++ b/doc/api/report.md @@ -598,5 +598,5 @@ The thread which is generating the report will wait for the reports from Worker threads to finish. However, the latency for this will usually be low, as both running JavaScript and the event loop are interrupted to generate the report. -[`process API documentation`]: process.md [`Worker`]: worker_threads.md +[`process API documentation`]: process.md diff --git a/doc/api/stream.md b/doc/api/stream.md index b10e0416157..ff92207c07e 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -3080,6 +3080,12 @@ This is not a problem in common cases with `latin1` or `ascii`. But it is advised to be mindful about this behavior when working with strings that could contain multi-byte characters. +[API for stream consumers]: #stream_api_for_stream_consumers +[API for stream implementers]: #stream_api_for_stream_implementers +[Compatibility]: #stream_compatibility_with_older_node_js_versions +[HTTP requests, on the client]: http.md#http_class_http_clientrequest +[HTTP responses, on the server]: http.md#http_class_http_serverresponse +[TCP sockets]: net.md#net_class_net_socket [`'data'`]: #stream_event_data [`'drain'`]: #stream_event_drain [`'end'`]: #stream_event_end @@ -3116,12 +3122,6 @@ contain multi-byte characters. [`writable.uncork()`]: #stream_writable_uncork [`writable.writableFinished`]: #stream_writable_writablefinished [`zlib.createDeflate()`]: zlib.md#zlib_zlib_createdeflate_options -[API for stream consumers]: #stream_api_for_stream_consumers -[API for stream implementers]: #stream_api_for_stream_implementers -[Compatibility]: #stream_compatibility_with_older_node_js_versions -[HTTP requests, on the client]: http.md#http_class_http_clientrequest -[HTTP responses, on the server]: http.md#http_class_http_serverresponse -[TCP sockets]: net.md#net_class_net_socket [child process stdin]: child_process.md#child_process_subprocess_stdin [child process stdout and stderr]: child_process.md#child_process_subprocess_stdout [crypto]: crypto.md diff --git a/doc/api/tls.md b/doc/api/tls.md index 679ba46220d..a8d44e9aacb 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -1976,21 +1976,36 @@ added: v11.4.0 `'TLSv1.3'`. If multiple of the options are provided, the lowest minimum is used. +[Chrome's 'modern cryptography' setting]: https://www.chromium.org/Home/chromium-security/education/tls#TOC-Cipher-Suites +[DHE]: https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange +[ECDHE]: https://en.wikipedia.org/wiki/Elliptic_curve_Diffie%E2%80%93Hellman +[Mozilla's publicly trusted list of CAs]: https://hg.mozilla.org/mozilla-central/raw-file/tip/security/nss/lib/ckfw/builtins/certdata.txt +[OCSP request]: https://en.wikipedia.org/wiki/OCSP_stapling +[OpenSSL Options]: crypto.md#crypto_openssl_options +[RFC 2246]: https://www.ietf.org/rfc/rfc2246.txt +[RFC 4086]: https://tools.ietf.org/html/rfc4086 +[RFC 4279]: https://tools.ietf.org/html/rfc4279 +[RFC 5077]: https://tools.ietf.org/html/rfc5077 +[RFC 5929]: https://tools.ietf.org/html/rfc5929 +[SSL_METHODS]: https://www.openssl.org/docs/man1.1.1/man7/ssl.html#Dealing-with-Protocol-Methods +[Session Resumption]: #tls_session_resumption +[Stream]: stream.md#stream_stream +[TLS recommendations]: https://wiki.mozilla.org/Security/Server_Side_TLS +[`--tls-cipher-list`]: cli.md#cli_tls_cipher_list_list +[`Duplex`]: stream.md#stream_class_stream_duplex +[`NODE_OPTIONS`]: cli.md#cli_node_options_options [`'newSession'`]: #tls_event_newsession [`'resumeSession'`]: #tls_event_resumesession [`'secureConnect'`]: #tls_event_secureconnect [`'secureConnection'`]: #tls_event_secureconnection [`'session'`]: #tls_event_session -[`--tls-cipher-list`]: cli.md#cli_tls_cipher_list_list -[`NODE_OPTIONS`]: cli.md#cli_node_options_options [`SSL_export_keying_material`]: https://www.openssl.org/docs/man1.1.1/man3/SSL_export_keying_material.html [`SSL_get_version`]: https://www.openssl.org/docs/man1.1.1/man3/SSL_get_version.html [`crypto.getCurves()`]: crypto.md#crypto_crypto_getcurves -[`Duplex`]: stream.md#stream_class_stream_duplex -[`net.createServer()`]: net.md#net_net_createserver_options_connectionlistener [`net.Server.address()`]: net.md#net_server_address [`net.Server`]: net.md#net_class_net_server [`net.Socket`]: net.md#net_class_net_socket +[`net.createServer()`]: net.md#net_net_createserver_options_connectionlistener [`server.addContext()`]: #tls_server_addcontext_hostname_context [`server.getTicketKeys()`]: #tls_server_getticketkeys [`server.listen()`]: net.md#net_server_listen @@ -2011,25 +2026,10 @@ added: v11.4.0 [`tls.createServer()`]: #tls_tls_createserver_options_secureconnectionlistener [`tls.getCiphers()`]: #tls_tls_getciphers [`tls.rootCertificates`]: #tls_tls_rootcertificates -[Chrome's 'modern cryptography' setting]: https://www.chromium.org/Home/chromium-security/education/tls#TOC-Cipher-Suites -[DHE]: https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange -[ECDHE]: https://en.wikipedia.org/wiki/Elliptic_curve_Diffie%E2%80%93Hellman -[forward secrecy]: https://en.wikipedia.org/wiki/Perfect_forward_secrecy -[Mozilla's publicly trusted list of CAs]: https://hg.mozilla.org/mozilla-central/raw-file/tip/security/nss/lib/ckfw/builtins/certdata.txt -[OCSP request]: https://en.wikipedia.org/wiki/OCSP_stapling -[OpenSSL Options]: crypto.md#crypto_openssl_options -[perfect forward secrecy]: #tls_perfect_forward_secrecy -[RFC 2246]: https://www.ietf.org/rfc/rfc2246.txt -[RFC 5077]: https://tools.ietf.org/html/rfc5077 -[RFC 5929]: https://tools.ietf.org/html/rfc5929 -[SSL_METHODS]: https://www.openssl.org/docs/man1.1.1/man7/ssl.html#Dealing-with-Protocol-Methods -[Session Resumption]: #tls_session_resumption -[Stream]: stream.md#stream_stream -[TLS recommendations]: https://wiki.mozilla.org/Security/Server_Side_TLS [asn1.js]: https://www.npmjs.com/package/asn1.js [certificate object]: #tls_certificate_object [cipher list format]: https://www.openssl.org/docs/man1.1.1/man1/ciphers.html#CIPHER-LIST-FORMAT +[forward secrecy]: https://en.wikipedia.org/wiki/Perfect_forward_secrecy [modifying the default cipher suite]: #tls_modifying_the_default_tls_cipher_suite [specific attacks affecting larger AES key sizes]: https://www.schneier.com/blog/archives/2009/07/another_new_aes.html -[RFC 4279]: https://tools.ietf.org/html/rfc4279 -[RFC 4086]: https://tools.ietf.org/html/rfc4086 +[perfect forward secrecy]: #tls_perfect_forward_secrecy diff --git a/doc/api/url.md b/doc/api/url.md index 849d2877baf..d2ba4f3b098 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -1370,6 +1370,10 @@ console.log(myURL.origin); // Prints https://xn--1xa.example.com ``` +[ICU]: intl.md#intl_options_for_building_node_js +[Punycode]: https://tools.ietf.org/html/rfc5891#section-4.4 +[WHATWG URL Standard]: https://url.spec.whatwg.org/ +[WHATWG URL]: #url_the_whatwg_url_api [`Error`]: errors.md#errors_class_error [`JSON.stringify()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify [`Map`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map @@ -1389,10 +1393,6 @@ console.log(myURL.origin); [`url.toString()`]: #url_url_tostring [`urlSearchParams.entries()`]: #url_urlsearchparams_entries [`urlSearchParams@@iterator()`]: #url_urlsearchparams_symbol_iterator -[ICU]: intl.md#intl_options_for_building_node_js -[Punycode]: https://tools.ietf.org/html/rfc5891#section-4.4 -[WHATWG URL Standard]: https://url.spec.whatwg.org/ -[WHATWG URL]: #url_the_whatwg_url_api [examples of parsed URLs]: https://url.spec.whatwg.org/#example-url-parsing [host name spoofing]: https://hackerone.com/reports/678487 [legacy `urlObject`]: #url_legacy_urlobject diff --git a/doc/api/util.md b/doc/api/util.md index ac40cb35cad..ecdfc837b06 100644 --- a/doc/api/util.md +++ b/doc/api/util.md @@ -2445,6 +2445,13 @@ const util = require('util'); util.log('Timestamped message.'); ``` +[Common System Errors]: errors.md#errors_common_system_errors +[Custom inspection functions on objects]: #util_custom_inspection_functions_on_objects +[Custom promisified functions]: #util_custom_promisified_functions +[Customizing `util.inspect` colors]: #util_customizing_util_inspect_colors +[Internationalization]: intl.md +[Module Namespace Object]: https://tc39.github.io/ecma262/#sec-module-namespace-exotic-objects +[WHATWG Encoding Standard]: https://encoding.spec.whatwg.org/ [`'uncaughtException'`]: process.md#process_event_uncaughtexception [`'warning'`]: process.md#process_event_warning [`Array.isArray()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray @@ -2476,6 +2483,7 @@ util.log('Timestamped message.'); [`WebAssembly.Module`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Module [`assert.deepStrictEqual()`]: assert.md#assert_assert_deepstrictequal_actual_expected_message [`console.error()`]: console.md#console_console_error_data_args +[`napi_create_external()`]: n-api.md#n_api_napi_create_external [`target` and `handler`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy#Terminology [`tty.hasColors()`]: tty.md#tty_writestream_hascolors_count_env [`util.format()`]: #util_util_format_format_args @@ -2486,19 +2494,11 @@ util.log('Timestamped message.'); [`util.types.isDate()`]: #util_util_types_isdate_value [`util.types.isNativeError()`]: #util_util_types_isnativeerror_value [`util.types.isSharedArrayBuffer()`]: #util_util_types_issharedarraybuffer_value -[Common System Errors]: errors.md#errors_common_system_errors -[Custom inspection functions on objects]: #util_custom_inspection_functions_on_objects -[Custom promisified functions]: #util_custom_promisified_functions -[Customizing `util.inspect` colors]: #util_customizing_util_inspect_colors -[Internationalization]: intl.md -[Module Namespace Object]: https://tc39.github.io/ecma262/#sec-module-namespace-exotic-objects -[WHATWG Encoding Standard]: https://encoding.spec.whatwg.org/ [async function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/async_function [compare function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#Parameters [constructor]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/constructor [default sort]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort [global symbol registry]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/for [list of deprecated APIS]: deprecations.md#deprecations_list_of_deprecated_apis -[`napi_create_external()`]: n-api.md#n_api_napi_create_external [semantically incompatible]: https://github.com/nodejs/node/issues/4179 [util.inspect.custom]: #util_util_inspect_custom diff --git a/doc/api/v8.md b/doc/api/v8.md index 5bd28b2673f..54e01806079 100644 --- a/doc/api/v8.md +++ b/doc/api/v8.md @@ -503,6 +503,8 @@ added: v8.0.0 A subclass of [`Deserializer`][] corresponding to the format written by [`DefaultSerializer`][]. +[HTML structured clone algorithm]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm +[V8]: https://developers.google.com/v8/ [`Buffer`]: buffer.md [`DefaultDeserializer`]: #v8_class_v8_defaultdeserializer [`DefaultSerializer`]: #v8_class_v8_defaultserializer @@ -519,6 +521,4 @@ A subclass of [`Deserializer`][] corresponding to the format written by [`serializer.transferArrayBuffer()`]: #v8_serializer_transferarraybuffer_id_arraybuffer [`serializer.writeRawBytes()`]: #v8_serializer_writerawbytes_buffer [`vm.Script`]: vm.md#vm_new_vm_script_code_options -[HTML structured clone algorithm]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm -[V8]: https://developers.google.com/v8/ [worker threads]: worker_threads.md diff --git a/doc/api/vm.md b/doc/api/vm.md index 69dea1866d7..4fb4ead6955 100644 --- a/doc/api/vm.md +++ b/doc/api/vm.md @@ -1308,6 +1308,16 @@ inside a `vm.Context`, functions passed to them will be added to global queues, which are shared by all contexts. Therefore, callbacks passed to those functions are not controllable through the timeout either. +[Cyclic Module Record]: https://tc39.es/ecma262/#sec-cyclic-module-records +[ECMAScript Module Loader]: esm.md#esm_modules_ecmascript_modules +[Evaluate() concrete method]: https://tc39.es/ecma262/#sec-moduleevaluation +[GetModuleNamespace]: https://tc39.es/ecma262/#sec-getmodulenamespace +[HostResolveImportedModule]: https://tc39.es/ecma262/#sec-hostresolveimportedmodule +[Link() concrete method]: https://tc39.es/ecma262/#sec-moduledeclarationlinking +[Module Record]: https://www.ecma-international.org/ecma-262/#sec-abstract-module-records +[Source Text Module Record]: https://tc39.es/ecma262/#sec-source-text-module-records +[Synthetic Module Record]: https://heycam.github.io/webidl/#synthetic-module-records +[V8 Embedder's Guide]: https://v8.dev/docs/embed#contexts [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`]: errors.md#ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING [`ERR_VM_MODULE_STATUS`]: errors.md#ERR_VM_MODULE_STATUS [`Error`]: errors.md#errors_class_error @@ -1319,16 +1329,6 @@ are not controllable through the timeout either. [`vm.createContext()`]: #vm_vm_createcontext_contextobject_options [`vm.runInContext()`]: #vm_vm_runincontext_code_contextifiedobject_options [`vm.runInThisContext()`]: #vm_vm_runinthiscontext_code_options -[Cyclic Module Record]: https://tc39.es/ecma262/#sec-cyclic-module-records -[ECMAScript Module Loader]: esm.md#esm_modules_ecmascript_modules -[Evaluate() concrete method]: https://tc39.es/ecma262/#sec-moduleevaluation -[GetModuleNamespace]: https://tc39.es/ecma262/#sec-getmodulenamespace -[HostResolveImportedModule]: https://tc39.es/ecma262/#sec-hostresolveimportedmodule -[Link() concrete method]: https://tc39.es/ecma262/#sec-moduledeclarationlinking -[Module Record]: https://www.ecma-international.org/ecma-262/#sec-abstract-module-records -[Source Text Module Record]: https://tc39.es/ecma262/#sec-source-text-module-records -[Synthetic Module Record]: https://heycam.github.io/webidl/#synthetic-module-records -[V8 Embedder's Guide]: https://v8.dev/docs/embed#contexts [contextified]: #vm_what_does_it_mean_to_contextify_an_object [global object]: https://es5.github.io/#x15.1 [indirect `eval()` call]: https://es5.github.io/#x10.4.2 diff --git a/doc/api/worker_threads.md b/doc/api/worker_threads.md index 308b53c2314..dddf87403bb 100644 --- a/doc/api/worker_threads.md +++ b/doc/api/worker_threads.md @@ -902,13 +902,17 @@ Calling `unref()` on a worker will allow the thread to exit if this is the only active handle in the event system. If the worker is already `unref()`ed calling `unref()` again will have no effect. +[Addons worker support]: addons.md#addons_worker_support +[ECMAScript module loader]: esm.md#esm_data_imports +[HTML structured clone algorithm]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm +[Signals events]: process.md#process_signal_events +[Web Workers]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API [`'close'` event]: #worker_threads_event_close [`'exit'` event]: #worker_threads_event_exit [`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer [`AsyncResource`]: async_hooks.md#async_hooks_class_asyncresource -[`Buffer`]: buffer.md [`Buffer.allocUnsafe()`]: buffer.md#buffer_static_method_buffer_allocunsafe_size -[ECMAScript module loader]: esm.md#esm_data_imports +[`Buffer`]: buffer.md [`ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST`]: errors.md#errors_err_missing_message_port_in_transfer_list [`ERR_WORKER_NOT_RUNNING`]: errors.md#ERR_WORKER_NOT_RUNNING [`EventEmitter`]: events.md @@ -921,8 +925,9 @@ active handle in the event system. If the worker is already `unref()`ed calling [`WebAssembly.Module`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Module [`Worker`]: #worker_threads_class_worker [`cluster` module]: cluster.md -[`fs.open()`]: fs.md#fs_fs_open_path_flags_mode_callback +[`data:` URL]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs [`fs.close()`]: fs.md#fs_fs_close_fd_callback +[`fs.open()`]: fs.md#fs_fs_open_path_flags_mode_callback [`markAsUntransferable()`]: #worker_threads_worker_markasuntransferable_object [`port.on('message')`]: #worker_threads_event_message [`port.onmessage()`]: https://developer.mozilla.org/en-US/docs/Web/API/MessagePort/onmessage @@ -951,13 +956,8 @@ active handle in the event system. If the worker is already `unref()`ed calling [`worker.SHARE_ENV`]: #worker_threads_worker_share_env [`worker.terminate()`]: #worker_threads_worker_terminate [`worker.threadId`]: #worker_threads_worker_threadid_1 -[Addons worker support]: addons.md#addons_worker_support [async-resource-worker-pool]: async_hooks.md#async-resource-worker-pool -[HTML structured clone algorithm]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Structured_clone_algorithm -[Signals events]: process.md#process_signal_events -[Web Workers]: https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API [browser `MessagePort`]: https://developer.mozilla.org/en-US/docs/Web/API/MessagePort [child processes]: child_process.md [contextified]: vm.md#vm_what_does_it_mean_to_contextify_an_object [v8.serdes]: v8.md#v8_serialization_api -[`data:` URL]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs diff --git a/doc/api/zlib.md b/doc/api/zlib.md index 5b182530d56..0370c68ef65 100644 --- a/doc/api/zlib.md +++ b/doc/api/zlib.md @@ -1167,13 +1167,16 @@ changes: Decompress a chunk of data with [`Unzip`][]. +[Brotli parameters]: #zlib_brotli_constants +[Memory usage tuning]: #zlib_memory_usage_tuning +[RFC 7932]: https://www.rfc-editor.org/rfc/rfc7932.txt +[Streams API]: stream.md [`.flush()`]: #zlib_zlib_flush_kind_callback [`Accept-Encoding`]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.3 [`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer [`BrotliCompress`]: #zlib_class_zlib_brotlicompress [`BrotliDecompress`]: #zlib_class_zlib_brotlidecompress [`Buffer`]: buffer.md#buffer_class_buffer -[`buffer.kMaxLength`]: buffer.md#buffer_buffer_kmaxlength [`Content-Encoding`]: https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11 [`DataView`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView [`DeflateRaw`]: #zlib_class_zlib_deflateraw @@ -1184,13 +1187,10 @@ Decompress a chunk of data with [`Unzip`][]. [`Inflate`]: #zlib_class_zlib_inflate [`TypedArray`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray [`Unzip`]: #zlib_class_zlib_unzip +[`buffer.kMaxLength`]: buffer.md#buffer_buffer_kmaxlength [`deflateInit2` and `inflateInit2`]: https://zlib.net/manual.html#Advanced [`stream.Transform`]: stream.md#stream_class_stream_transform [`zlib.bytesWritten`]: #zlib_zlib_byteswritten -[Brotli parameters]: #zlib_brotli_constants -[Memory usage tuning]: #zlib_memory_usage_tuning -[RFC 7932]: https://www.rfc-editor.org/rfc/rfc7932.txt -[Streams API]: stream.md [convenience methods]: #zlib_convenience_methods [zlib documentation]: https://zlib.net/manual.html#Constants [zlib.createGzip example]: #zlib_zlib |