From ecf5060a42a5cd073ed4200e80afae1a79178bba Mon Sep 17 00:00:00 2001 From: Antoine du Hamel Date: Mon, 14 Sep 2020 17:09:13 +0200 Subject: [PATCH] doc: use .md extension for internal links This helps catch broken links as part of the test suite. This also improves the user experience when browsing the markdown files. PR-URL: https://github.com/nodejs/node/pull/35191 Fixes: https://github.com/nodejs/node/issues/35189 Reviewed-By: Derek Lewis Reviewed-By: Jiawen Geng Reviewed-By: Trivikram Kamat Reviewed-By: Richard Lau Reviewed-By: Rich Trott --- doc/api/addons.md | 10 +- doc/api/assert.md | 12 +- doc/api/async_hooks.md | 8 +- doc/api/buffer.md | 8 +- doc/api/child_process.md | 24 +- doc/api/cli.md | 26 +- doc/api/cluster.md | 20 +- doc/api/console.md | 14 +- doc/api/crypto.md | 18 +- doc/api/debugger.md | 2 +- doc/api/deprecations.md | 244 +++++++++--------- doc/api/dgram.md | 18 +- doc/api/dns.md | 10 +- doc/api/documentation.md | 2 +- doc/api/domain.md | 6 +- doc/api/embedding.md | 6 +- doc/api/errors.md | 130 +++++----- doc/api/esm.md | 22 +- doc/api/events.md | 12 +- doc/api/fs.md | 22 +- doc/api/globals.md | 42 +-- doc/api/http.md | 52 ++-- doc/api/http2.md | 42 +-- doc/api/https.md | 42 +-- doc/api/index.md | 112 ++++---- doc/api/inspector.md | 2 +- doc/api/intl.md | 12 +- doc/api/module.md | 12 +- doc/api/modules.md | 18 +- doc/api/n-api.md | 18 +- doc/api/net.md | 24 +- doc/api/os.md | 6 +- doc/api/packages.md | 12 +- doc/api/path.md | 2 +- doc/api/perf_hooks.md | 8 +- doc/api/process.md | 70 ++--- doc/api/quic.md | 10 +- doc/api/readline.md | 16 +- doc/api/repl.md | 20 +- doc/api/report.md | 4 +- doc/api/stream.md | 36 +-- doc/api/string_decoder.md | 2 +- doc/api/synopsis.md | 4 +- doc/api/timers.md | 20 +- doc/api/tls.md | 24 +- doc/api/tracing.md | 8 +- doc/api/tty.md | 10 +- doc/api/url.md | 8 +- doc/api/util.md | 22 +- doc/api/v8.md | 8 +- doc/api/vm.md | 12 +- doc/api/worker_threads.md | 60 ++--- doc/api/zlib.md | 6 +- .../test-local-md-file-reference-regex.js | 47 ++++ tools/doc/html.js | 4 +- tools/doc/markdown.js | 13 +- 56 files changed, 741 insertions(+), 681 deletions(-) create mode 100644 test/doctool/test-local-md-file-reference-regex.js diff --git a/doc/api/addons.md b/doc/api/addons.md index bfe527cac9..aa71f8726f 100644 --- a/doc/api/addons.md +++ b/doc/api/addons.md @@ -10,7 +10,7 @@ Addons provide an interface between JavaScript and C/C++ libraries. There are three options for implementing addons: N-API, nan, or direct use of internal V8, libuv and Node.js libraries. Unless there is a need for direct access to functionality which is not exposed by N-API, use N-API. -Refer to [C/C++ addons with N-API](n-api.html) for more information on N-API. +Refer to [C/C++ addons with N-API](n-api.md) for more information on N-API. When not using N-API, implementing addons is complicated, involving knowledge of several components and APIs: @@ -452,7 +452,7 @@ in the N-API are used. Creating and maintaining an addon that benefits from the ABI stability provided by N-API carries with it certain -[implementation considerations](n-api.html#n_api_implications_of_abi_stability). +[implementation considerations](n-api.md#n_api_implications_of_abi_stability). To use N-API in the above "Hello world" example, replace the content of `hello.cc` with the following. All other instructions remain the same. @@ -490,7 +490,7 @@ NAPI_MODULE(NODE_GYP_MODULE_NAME, init) ``` The functions available and how to use them are documented in -[C/C++ addons with N-API](n-api.html). +[C/C++ addons with N-API](n-api.md). ## Addon examples @@ -1356,7 +1356,7 @@ console.log(result); // Prints: 30 ``` -[`Worker`]: worker_threads.html#worker_threads_class_worker +[`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 @@ -1367,5 +1367,5 @@ console.log(result); [installation instructions]: https://github.com/nodejs/node-gyp#installation [libuv]: https://github.com/libuv/libuv [node-gyp]: https://github.com/nodejs/node-gyp -[require]: modules.html#modules_require_id +[require]: modules.md#modules_require_id [v8-docs]: https://v8docs.nodesource.com/ diff --git a/doc/api/assert.md b/doc/api/assert.md index 29db2999b5..07dc5f1a1b 100644 --- a/doc/api/assert.md +++ b/doc/api/assert.md @@ -70,7 +70,7 @@ assert.deepEqual([[[1, 2, 3]], 4, 5], [[[1, 2, '3']], 4, 5]); To deactivate the colors, use the `NO_COLOR` or `NODE_DISABLE_COLORS` environment variables. This will also deactivate the colors in the REPL. For more on color support in terminal environments, read the tty -[getColorDepth()](tty.html#tty_writestream_getcolordepth_env) documentation. +[getColorDepth()](tty.md#tty_writestream_getcolordepth_env) documentation. ## Legacy assertion mode @@ -1564,15 +1564,15 @@ argument. [`AssertionError`]: #assert_class_assert_assertionerror [`Class`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes -[`ERR_INVALID_RETURN_VALUE`]: errors.html#errors_err_invalid_return_value -[`Error.captureStackTrace`]: errors.html#errors_error_capturestacktrace_targetobject_constructoropt -[`Error`]: errors.html#errors_class_error +[`ERR_INVALID_RETURN_VALUE`]: errors.md#errors_err_invalid_return_value +[`Error.captureStackTrace`]: errors.md#errors_error_capturestacktrace_targetobject_constructoropt +[`Error`]: errors.md#errors_class_error [`Map`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map [`Object.is()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/is [`RegExp`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions [`Set`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set [`Symbol`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol -[`TypeError`]: errors.html#errors_class_typeerror +[`TypeError`]: errors.md#errors_class_typeerror [`WeakMap`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap [`WeakSet`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakSet [`CallTracker`]: #assert_class_assert_calltracker @@ -1587,7 +1587,7 @@ argument. [`assert.ok()`]: #assert_assert_ok_value_message [`assert.strictEqual()`]: #assert_assert_strictequal_actual_expected_message [`assert.throws()`]: #assert_assert_throws_fn_error_message -[`process.on('exit')`]: process.html#process_event_exit +[`process.on('exit')`]: process.md#process_event_exit [`tracker.calls()`]: #assert_tracker_calls_fn_exact [`tracker.verify()`]: #assert_tracker_verify [strict assertion mode]: #assert_strict_assertion_mode diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md index fcab499cbd..c1fe2facc9 100644 --- a/doc/api/async_hooks.md +++ b/doc/api/async_hooks.md @@ -1189,10 +1189,10 @@ to associate the asynchronous operation with the correct execution context. [`destroy` callback]: #async_hooks_destroy_asyncid [`init` callback]: #async_hooks_init_asyncid_type_triggerasyncid_resource [`promiseResolve` callback]: #async_hooks_promiseresolve_asyncid -[`EventEmitter`]: events.html#events_class_eventemitter +[`EventEmitter`]: events.md#events_class_eventemitter [Hook Callbacks]: #async_hooks_hook_callbacks [PromiseHooks]: https://docs.google.com/document/d/1rda3yKGHimKIhg5YeoAmCOtyURgsbTH_qaYR79FELlk/edit -[`Stream`]: stream.html#stream_stream -[`Worker`]: worker_threads.html#worker_threads_class_worker +[`Stream`]: stream.md#stream_stream +[`Worker`]: worker_threads.md#worker_threads_class_worker [promise execution tracking]: #async_hooks_promise_execution_tracking -[`util.promisify()`]: util.html#util_util_promisify_original +[`util.promisify()`]: util.md#util_util_promisify_original diff --git a/doc/api/buffer.md b/doc/api/buffer.md index 8b0bd321b9..7981b9f93a 100644 --- a/doc/api/buffer.md +++ b/doc/api/buffer.md @@ -3286,9 +3286,9 @@ 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.html#ERR_INVALID_BUFFER_SIZE -[`ERR_INVALID_ARG_VALUE`]: errors.html#ERR_INVALID_ARG_VALUE -[`ERR_OUT_OF_RANGE`]: errors.html#ERR_OUT_OF_RANGE +[`ERR_INVALID_BUFFER_SIZE`]: errors.md#ERR_INVALID_BUFFER_SIZE +[`ERR_INVALID_ARG_VALUE`]: errors.md#ERR_INVALID_ARG_VALUE +[`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 @@ -3313,7 +3313,7 @@ introducing security vulnerabilities into an application. [`buffer.constants.MAX_LENGTH`]: #buffer_buffer_constants_max_length [`buffer.constants.MAX_STRING_LENGTH`]: #buffer_buffer_constants_max_string_length [`buffer.kMaxLength`]: #buffer_buffer_kmaxlength -[`util.inspect()`]: util.html#util_util_inspect_object_options +[`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 diff --git a/doc/api/child_process.md b/doc/api/child_process.md index 31b5018f54..dd0a6a51d3 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -1583,13 +1583,13 @@ Therefore, this feature requires opting in by setting the or [`child_process.fork()`][]. [Advanced serialization]: #child_process_advanced_serialization -[`'disconnect'`]: process.html#process_event_disconnect +[`'disconnect'`]: process.md#process_event_disconnect [`'error'`]: #child_process_event_error [`'exit'`]: #child_process_event_exit -[`'message'`]: process.html#process_event_message +[`'message'`]: process.md#process_event_message [`ChildProcess`]: #child_process_child_process -[`Error`]: errors.html#errors_class_error -[`EventEmitter`]: events.html#events_class_eventemitter +[`Error`]: errors.md#errors_class_error +[`EventEmitter`]: events.md#events_class_eventemitter [`child_process.exec()`]: #child_process_child_process_exec_command_options_callback [`child_process.execFile()`]: #child_process_child_process_execfile_file_args_options_callback [`child_process.execFileSync()`]: #child_process_child_process_execfilesync_file_args_options @@ -1598,13 +1598,13 @@ or [`child_process.fork()`][]. [`child_process.spawn()`]: #child_process_child_process_spawn_command_args_options [`child_process.spawnSync()`]: #child_process_child_process_spawnsync_command_args_options [`maxBuffer` and Unicode]: #child_process_maxbuffer_and_unicode -[`net.Server`]: net.html#net_class_net_server -[`net.Socket`]: net.html#net_class_net_socket +[`net.Server`]: net.md#net_class_net_server +[`net.Socket`]: net.md#net_class_net_socket [`options.detached`]: #child_process_options_detached -[`process.disconnect()`]: process.html#process_process_disconnect -[`process.env`]: process.html#process_process_env -[`process.execPath`]: process.html#process_process_execpath -[`process.send()`]: process.html#process_process_send_message_sendhandle_options_callback +[`process.disconnect()`]: process.md#process_process_disconnect +[`process.env`]: process.md#process_process_env +[`process.execPath`]: process.md#process_process_execpath +[`process.send()`]: process.md#process_process_send_message_sendhandle_options_callback [`stdio`]: #child_process_options_stdio [`subprocess.connected`]: #child_process_subprocess_connected [`subprocess.disconnect()`]: #child_process_subprocess_disconnect @@ -1614,9 +1614,9 @@ or [`child_process.fork()`][]. [`subprocess.stdin`]: #child_process_subprocess_stdin [`subprocess.stdio`]: #child_process_subprocess_stdio [`subprocess.stdout`]: #child_process_subprocess_stdout -[`util.promisify()`]: util.html#util_util_promisify_original +[`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.html#v8_serialization_api +[v8.serdes]: v8.md#v8_serialization_api diff --git a/doc/api/cli.md b/doc/api/cli.md index c92cd21e8e..aeb15dbca6 100644 --- a/doc/api/cli.md +++ b/doc/api/cli.md @@ -1584,27 +1584,27 @@ $ node --max-old-space-size=1536 index.js ``` [Chrome DevTools Protocol]: https://chromedevtools.github.io/devtools-protocol/ -[REPL]: repl.html +[REPL]: repl.md [ScriptCoverage]: https://chromedevtools.github.io/devtools-protocol/tot/Profiler#type-ScriptCoverage [Source Map]: https://sourcemaps.info/spec.html [Subresource Integrity]: https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity [V8 JavaScript code coverage]: https://v8project.blogspot.com/2017/12/javascript-code-coverage.html [`--openssl-config`]: #cli_openssl_config_file [`Atomics.wait()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Atomics/wait -[`Buffer`]: buffer.html#buffer_class_buffer +[`Buffer`]: buffer.md#buffer_class_buffer [`NODE_OPTIONS`]: #cli_node_options_options -[`SlowBuffer`]: buffer.html#buffer_class_slowbuffer -[`process.setUncaughtExceptionCaptureCallback()`]: process.html#process_process_setuncaughtexceptioncapturecallback_fn -[`tls.DEFAULT_MAX_VERSION`]: tls.html#tls_tls_default_max_version -[`tls.DEFAULT_MIN_VERSION`]: tls.html#tls_tls_default_min_version -[`unhandledRejection`]: process.html#process_event_unhandledrejection -[`worker_threads.threadId`]: worker_threads.html#worker_threads_worker_threadid -[context-aware]: addons.html#addons_context_aware_addons -[customizing ESM specifier resolution]: esm.html#esm_customizing_esm_specifier_resolution_algorithm -[debugger]: debugger.html +[`SlowBuffer`]: buffer.md#buffer_class_slowbuffer +[`process.setUncaughtExceptionCaptureCallback()`]: process.md#process_process_setuncaughtexceptioncapturecallback_fn +[`tls.DEFAULT_MAX_VERSION`]: tls.md#tls_tls_default_max_version +[`tls.DEFAULT_MIN_VERSION`]: tls.md#tls_tls_default_min_version +[`unhandledRejection`]: process.md#process_event_unhandledrejection +[`worker_threads.threadId`]: worker_threads.md#worker_threads_worker_threadid +[context-aware]: addons.md#addons_context_aware_addons +[customizing ESM specifier resolution]: esm.md#esm_customizing_esm_specifier_resolution_algorithm +[debugger]: debugger.md [debugging security implications]: https://nodejs.org/en/docs/guides/debugging-getting-started/#security-implications -[emit_warning]: process.html#process_process_emitwarning_warning_type_code_ctor -[experimental ECMAScript Module loader]: esm.html#esm_experimental_loaders +[emit_warning]: process.md#process_process_emitwarning_warning_type_code_ctor +[experimental ECMAScript Module loader]: esm.md#esm_experimental_loaders [jitless]: https://v8.dev/blog/jitless [libuv threadpool documentation]: https://docs.libuv.org/en/latest/threadpool.html [remote code execution]: https://www.owasp.org/index.php/Code_Injection diff --git a/doc/api/cluster.md b/doc/api/cluster.md index 92e4d42d60..461b490044 100644 --- a/doc/api/cluster.md +++ b/doc/api/cluster.md @@ -875,15 +875,15 @@ socket.on('data', (id) => { [`.fork()`]: #cluster_cluster_fork_env [`.setupMaster()`]: #cluster_cluster_setupmaster_settings -[`ChildProcess.send()`]: child_process.html#child_process_subprocess_send_message_sendhandle_options_callback -[`child_process.fork()`]: child_process.html#child_process_child_process_fork_modulepath_args_options -[`child_process` event: `'exit'`]: child_process.html#child_process_event_exit -[`child_process` event: `'message'`]: child_process.html#child_process_event_message +[`ChildProcess.send()`]: child_process.md#child_process_subprocess_send_message_sendhandle_options_callback +[`child_process.fork()`]: child_process.md#child_process_child_process_fork_modulepath_args_options +[`child_process` event: `'exit'`]: child_process.md#child_process_event_exit +[`child_process` event: `'message'`]: child_process.md#child_process_event_message [`cluster.settings`]: #cluster_cluster_settings -[`disconnect()`]: child_process.html#child_process_subprocess_disconnect -[`kill()`]: process.html#process_process_kill_pid_signal -[`process` event: `'message'`]: process.html#process_event_message -[`server.close()`]: net.html#net_event_close +[`disconnect()`]: child_process.md#child_process_subprocess_disconnect +[`kill()`]: process.md#process_process_kill_pid_signal +[`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.html#child_process_advanced_serialization -[Child Process module]: child_process.html#child_process_child_process_fork_modulepath_args_options +[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/console.md b/doc/api/console.md index 9e223e6ee9..05c76af3c7 100644 --- a/doc/api/console.md +++ b/doc/api/console.md @@ -556,12 +556,12 @@ This method does not display anything unless used in the inspector. The [`console.profileEnd()`]: #console_console_profileend_label [`console.time()`]: #console_console_time_label [`console.timeEnd()`]: #console_console_timeend_label -[`process.stderr`]: process.html#process_process_stderr -[`process.stdout`]: process.html#process_process_stdout -[`util.format()`]: util.html#util_util_format_format_args -[`util.inspect()`]: util.html#util_util_inspect_object_options -[customizing `util.inspect()` colors]: util.html#util_customizing_util_inspect_colors +[`process.stderr`]: process.md#process_process_stderr +[`process.stdout`]: process.md#process_process_stdout +[`util.format()`]: util.md#util_util_format_format_args +[`util.inspect()`]: util.md#util_util_inspect_object_options +[customizing `util.inspect()` colors]: util.md#util_customizing_util_inspect_colors [falsy]: https://developer.mozilla.org/en-US/docs/Glossary/Falsy -[inspector]: debugger.html -[note on process I/O]: process.html#process_a_note_on_process_i_o +[inspector]: debugger.md +[note on process I/O]: process.md#process_a_note_on_process_i_o [truthy]: https://developer.mozilla.org/en-US/docs/Glossary/Truthy diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 92e5451bc3..01d1f8a081 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -3552,11 +3552,11 @@ See the [list of SSL OP Flags][] for details. -[`Buffer`]: buffer.html +[`Buffer`]: buffer.md [`EVP_BytesToKey`]: https://www.openssl.org/docs/man1.1.0/crypto/EVP_BytesToKey.html [`KeyObject`]: #crypto_class_keyobject [`Sign`]: #crypto_class_sign -[`UV_THREADPOOL_SIZE`]: cli.html#cli_uv_threadpool_size_size +[`UV_THREADPOOL_SIZE`]: cli.md#cli_uv_threadpool_size_size [`Verify`]: #crypto_class_verify [`cipher.final()`]: #crypto_cipher_final_outputencoding [`cipher.update()`]: #crypto_cipher_update_data_inputencoding_outputencoding @@ -3594,12 +3594,12 @@ See the [list of SSL OP Flags][] for details. [`hmac.digest()`]: #crypto_hmac_digest_encoding [`hmac.update()`]: #crypto_hmac_update_data_inputencoding [`keyObject.export()`]: #crypto_keyobject_export_options -[`postMessage()`]: worker_threads.html#worker_threads_port_postmessage_value_transferlist +[`postMessage()`]: worker_threads.md#worker_threads_port_postmessage_value_transferlist [`sign.sign()`]: #crypto_sign_sign_privatekey_outputencoding [`sign.update()`]: #crypto_sign_update_data_inputencoding -[`stream.Writable` options]: stream.html#stream_new_stream_writable_options -[`stream.transform` options]: stream.html#stream_new_stream_transform_options -[`util.promisify()`]: util.html#util_util_promisify_original +[`stream.Writable` options]: stream.md#stream_new_stream_writable_options +[`stream.transform` options]: stream.md#stream_new_stream_transform_options +[`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 @@ -3620,10 +3620,10 @@ See the [list of SSL OP Flags][] for details. [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.html#buffer_buffers_and_character_encodings +[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 [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.html -[stream-writable-write]: stream.html#stream_writable_write_chunk_encoding_callback +[stream]: stream.md +[stream-writable-write]: stream.md#stream_writable_write_chunk_encoding_callback diff --git a/doc/api/debugger.md b/doc/api/debugger.md index 8253c176e4..2579a72b97 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.html +[worker threads]: worker_threads.md [ndb]: https://github.com/GoogleChromeLabs/ndb/ diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index cf1a3239e8..d93493f419 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -2650,127 +2650,127 @@ Type: Documentation-only The [`crypto.Certificate()` constructor][] is deprecated. Use [static methods of `crypto.Certificate()`][] instead. -[`--pending-deprecation`]: cli.html#cli_pending_deprecation -[`--throw-deprecation`]: cli.html#cli_throw_deprecation -[`--unhandled-rejections`]: cli.html#cli_unhandled_rejections_mode -[`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_static_method_buffer_allocunsafeslow_size -[`Buffer.from(array)`]: buffer.html#buffer_static_method_buffer_from_array -[`Buffer.from(buffer)`]: buffer.html#buffer_static_method_buffer_from_buffer -[`Buffer.isBuffer()`]: buffer.html#buffer_static_method_buffer_isbuffer_obj -[`Cipher`]: crypto.html#crypto_class_cipher -[`Decipher`]: crypto.html#crypto_class_decipher -[`EventEmitter.listenerCount(emitter, eventName)`]: events.html#events_eventemitter_listenercount_emitter_eventname -[`REPLServer.clearBufferedCommand()`]: repl.html#repl_replserver_clearbufferedcommand -[`ReadStream.open()`]: fs.html#fs_class_fs_readstream -[`Server.getConnections()`]: net.html#net_server_getconnections_callback -[`Server.listen({fd: })`]: net.html#net_server_listen_handle_backlog_callback -[`SlowBuffer`]: buffer.html#buffer_class_slowbuffer -[`WriteStream.open()`]: fs.html#fs_class_fs_writestream -[`assert`]: assert.html -[`asyncResource.runInAsyncScope()`]: async_hooks.html#async_hooks_asyncresource_runinasyncscope_fn_thisarg_args -[`child_process`]: child_process.html -[`clearInterval()`]: timers.html#timers_clearinterval_timeout -[`clearTimeout()`]: timers.html#timers_cleartimeout_timeout -[`console.error()`]: console.html#console_console_error_data_args -[`console.log()`]: console.html#console_console_log_data_args -[`crypto.Certificate()` constructor]: crypto.html#crypto_legacy_api -[`crypto.DEFAULT_ENCODING`]: crypto.html#crypto_crypto_default_encoding -[`crypto.createCipher()`]: crypto.html#crypto_crypto_createcipher_algorithm_password_options -[`crypto.createCipheriv()`]: crypto.html#crypto_crypto_createcipheriv_algorithm_key_iv_options -[`crypto.createDecipher()`]: crypto.html#crypto_crypto_createdecipher_algorithm_password_options -[`crypto.createDecipheriv()`]: crypto.html#crypto_crypto_createdecipheriv_algorithm_key_iv_options -[`crypto.fips`]: crypto.html#crypto_crypto_fips -[`crypto.pbkdf2()`]: crypto.html#crypto_crypto_pbkdf2_password_salt_iterations_keylen_digest_callback -[`crypto.randomBytes()`]: crypto.html#crypto_crypto_randombytes_size_callback -[`crypto.scrypt()`]: crypto.html#crypto_crypto_scrypt_password_salt_keylen_options_callback -[`decipher.final()`]: crypto.html#crypto_decipher_final_outputencoding -[`decipher.setAuthTag()`]: crypto.html#crypto_decipher_setauthtag_buffer -[`domain`]: domain.html -[`ecdh.setPublicKey()`]: crypto.html#crypto_ecdh_setpublickey_publickey_encoding -[`emitter.listenerCount(eventName)`]: events.html#events_emitter_listenercount_eventname -[`fs.FileHandle`]: fs.html#fs_class_filehandle -[`fs.access()`]: fs.html#fs_fs_access_path_mode_callback -[`fs.createReadStream()`]: fs.html#fs_fs_createreadstream_path_options -[`fs.createWriteStream()`]: fs.html#fs_fs_createwritestream_path_options -[`fs.exists(path, callback)`]: fs.html#fs_fs_exists_path_callback -[`fs.lchmod(path, mode, callback)`]: fs.html#fs_fs_lchmod_path_mode_callback -[`fs.lchmodSync(path, mode)`]: fs.html#fs_fs_lchmodsync_path_mode -[`fs.lchown(path, uid, gid, callback)`]: fs.html#fs_fs_lchown_path_uid_gid_callback -[`fs.lchownSync(path, uid, gid)`]: fs.html#fs_fs_lchownsync_path_uid_gid -[`fs.read()`]: fs.html#fs_fs_read_fd_buffer_offset_length_position_callback -[`fs.readSync()`]: fs.html#fs_fs_readsync_fd_buffer_offset_length_position -[`fs.stat()`]: fs.html#fs_fs_stat_path_options_callback -[`http.get()`]: http.html#http_http_get_options_callback -[`http.request()`]: http.html#http_http_request_options_callback -[`https.get()`]: https.html#https_https_get_options_callback -[`https.request()`]: https.html#https_https_request_options_callback -[`module.createRequire()`]: module.html#module_module_createrequire_filename -[`os.networkInterfaces()`]: os.html#os_os_networkinterfaces -[`os.tmpdir()`]: os.html#os_os_tmpdir -[`process.env`]: process.html#process_process_env -[`process.mainModule`]: process.html#process_process_mainmodule -[`punycode`]: punycode.html -[`require.extensions`]: modules.html#modules_require_extensions -[`require.main`]: modules.html#modules_accessing_the_main_module -[`request.abort()`]: http.html#http_request_abort -[`request.socket`]: http.html#http_request_socket -[`request.connection`]: http.html#http_request_connection -[`request.destroy()`]: http.html#http_request_destroy_error -[`response.socket`]: http.html#http_response_socket -[`response.connection`]: http.html#http_response_connection -[`response.end()`]: http.html#http_response_end_data_encoding_callback -[`response.finished`]: http.html#http_response_finished -[`response.writableFinished`]: http.html#http_response_writablefinished -[`response.writableEnded`]: http.html#http_response_writableended -[`script.createCachedData()`]: vm.html#vm_script_createcacheddata -[`setInterval()`]: timers.html#timers_setinterval_callback_delay_args -[`setTimeout()`]: timers.html#timers_settimeout_callback_delay_args -[`socket.bufferSize`]: net.html#net_socket_buffersize -[`timeout.ref()`]: timers.html#timers_timeout_ref -[`timeout.refresh()`]: timers.html#timers_timeout_refresh -[`timeout.unref()`]: timers.html#timers_timeout_unref -[`tls.CryptoStream`]: tls.html#tls_class_tls_cryptostream -[`tls.SecureContext`]: tls.html#tls_tls_createsecurecontext_options -[`tls.SecurePair`]: tls.html#tls_class_tls_securepair -[`tls.TLSSocket`]: tls.html#tls_class_tls_tlssocket -[`tls.checkServerIdentity()`]: tls.html#tls_tls_checkserveridentity_hostname_cert -[`tls.createSecureContext()`]: tls.html#tls_tls_createsecurecontext_options -[`url.format()`]: url.html#url_url_format_urlobject -[`url.parse()`]: url.html#url_url_parse_urlstring_parsequerystring_slashesdenotehost -[`url.resolve()`]: url.html#url_url_resolve_from_to -[`util._extend()`]: util.html#util_util_extend_target_source -[`util.getSystemErrorName()`]: util.html#util_util_getsystemerrorname_err -[`util.inspect()`]: util.html#util_util_inspect_object_options -[`util.inspect.custom`]: util.html#util_util_inspect_custom -[`util.isArray()`]: util.html#util_util_isarray_object -[`util.isBoolean()`]: util.html#util_util_isboolean_object -[`util.isBuffer()`]: util.html#util_util_isbuffer_object -[`util.isDate()`]: util.html#util_util_isdate_object -[`util.isError()`]: util.html#util_util_iserror_object -[`util.isFunction()`]: util.html#util_util_isfunction_object -[`util.isNull()`]: util.html#util_util_isnull_object -[`util.isNullOrUndefined()`]: util.html#util_util_isnullorundefined_object -[`util.isNumber()`]: util.html#util_util_isnumber_object -[`util.isObject()`]: util.html#util_util_isobject_object -[`util.isPrimitive()`]: util.html#util_util_isprimitive_object -[`util.isRegExp()`]: util.html#util_util_isregexp_object -[`util.isString()`]: util.html#util_util_isstring_object -[`util.isSymbol()`]: util.html#util_util_issymbol_object -[`util.isUndefined()`]: util.html#util_util_isundefined_object -[`util.log()`]: util.html#util_util_log_string -[`util.types`]: util.html#util_util_types -[`util`]: util.html -[`worker.exitedAfterDisconnect`]: cluster.html#cluster_worker_exitedafterdisconnect -[`worker.terminate()`]: worker_threads.html#worker_threads_worker_terminate -[`writable.writableLength`]: stream.html#stream_writable_writablelength -[`zlib.bytesWritten`]: zlib.html#zlib_zlib_byteswritten -[Legacy URL API]: url.html#url_legacy_url_api +[`--pending-deprecation`]: cli.md#cli_pending_deprecation +[`--throw-deprecation`]: cli.md#cli_throw_deprecation +[`--unhandled-rejections`]: cli.md#cli_unhandled_rejections_mode +[`Buffer.allocUnsafeSlow(size)`]: buffer.md#buffer_static_method_buffer_allocunsafeslow_size +[`Buffer.from(array)`]: buffer.md#buffer_static_method_buffer_from_array +[`Buffer.from(buffer)`]: buffer.md#buffer_static_method_buffer_from_buffer +[`Buffer.isBuffer()`]: buffer.md#buffer_static_method_buffer_isbuffer_obj +[`Cipher`]: crypto.md#crypto_class_cipher +[`Decipher`]: crypto.md#crypto_class_decipher +[`EventEmitter.listenerCount(emitter, eventName)`]: events.md#events_eventemitter_listenercount_emitter_eventname +[`REPLServer.clearBufferedCommand()`]: repl.md#repl_replserver_clearbufferedcommand +[`ReadStream.open()`]: fs.md#fs_class_fs_readstream +[`Server.getConnections()`]: net.md#net_server_getconnections_callback +[`Server.listen({fd: })`]: net.md#net_server_listen_handle_backlog_callback +[`SlowBuffer`]: buffer.md#buffer_class_slowbuffer +[`WriteStream.open()`]: fs.md#fs_class_fs_writestream +[`assert`]: assert.md +[`asyncResource.runInAsyncScope()`]: async_hooks.md#async_hooks_asyncresource_runinasyncscope_fn_thisarg_args +[`child_process`]: child_process.md +[`clearInterval()`]: timers.md#timers_clearinterval_timeout +[`clearTimeout()`]: timers.md#timers_cleartimeout_timeout +[`console.error()`]: console.md#console_console_error_data_args +[`console.log()`]: console.md#console_console_log_data_args +[`crypto.Certificate()` constructor]: crypto.md#crypto_legacy_api +[`crypto.DEFAULT_ENCODING`]: crypto.md#crypto_crypto_default_encoding +[`crypto.createCipher()`]: crypto.md#crypto_crypto_createcipher_algorithm_password_options +[`crypto.createCipheriv()`]: crypto.md#crypto_crypto_createcipheriv_algorithm_key_iv_options +[`crypto.createDecipher()`]: crypto.md#crypto_crypto_createdecipher_algorithm_password_options +[`crypto.createDecipheriv()`]: crypto.md#crypto_crypto_createdecipheriv_algorithm_key_iv_options +[`crypto.fips`]: crypto.md#crypto_crypto_fips +[`crypto.pbkdf2()`]: crypto.md#crypto_crypto_pbkdf2_password_salt_iterations_keylen_digest_callback +[`crypto.randomBytes()`]: crypto.md#crypto_crypto_randombytes_size_callback +[`crypto.scrypt()`]: crypto.md#crypto_crypto_scrypt_password_salt_keylen_options_callback +[`decipher.final()`]: crypto.md#crypto_decipher_final_outputencoding +[`decipher.setAuthTag()`]: crypto.md#crypto_decipher_setauthtag_buffer +[`domain`]: domain.md +[`ecdh.setPublicKey()`]: crypto.md#crypto_ecdh_setpublickey_publickey_encoding +[`emitter.listenerCount(eventName)`]: events.md#events_emitter_listenercount_eventname +[`fs.FileHandle`]: fs.md#fs_class_filehandle +[`fs.access()`]: fs.md#fs_fs_access_path_mode_callback +[`fs.createReadStream()`]: fs.md#fs_fs_createreadstream_path_options +[`fs.createWriteStream()`]: fs.md#fs_fs_createwritestream_path_options +[`fs.exists(path, callback)`]: fs.md#fs_fs_exists_path_callback +[`fs.lchmod(path, mode, callback)`]: fs.md#fs_fs_lchmod_path_mode_callback +[`fs.lchmodSync(path, mode)`]: fs.md#fs_fs_lchmodsync_path_mode +[`fs.lchown(path, uid, gid, callback)`]: fs.md#fs_fs_lchown_path_uid_gid_callback +[`fs.lchownSync(path, uid, gid)`]: fs.md#fs_fs_lchownsync_path_uid_gid +[`fs.read()`]: fs.md#fs_fs_read_fd_buffer_offset_length_position_callback +[`fs.readSync()`]: fs.md#fs_fs_readsync_fd_buffer_offset_length_position +[`fs.stat()`]: fs.md#fs_fs_stat_path_options_callback +[`http.get()`]: http.md#http_http_get_options_callback +[`http.request()`]: http.md#http_http_request_options_callback +[`https.get()`]: https.md#https_https_get_options_callback +[`https.request()`]: https.md#https_https_request_options_callback +[`module.createRequire()`]: module.md#module_module_createrequire_filename +[`os.networkInterfaces()`]: os.md#os_os_networkinterfaces +[`os.tmpdir()`]: os.md#os_os_tmpdir +[`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 +[`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.writableEnded`]: http.md#http_response_writableended +[`script.createCachedData()`]: vm.md#vm_script_createcacheddata +[`setInterval()`]: timers.md#timers_setinterval_callback_delay_args +[`setTimeout()`]: timers.md#timers_settimeout_callback_delay_args +[`socket.bufferSize`]: net.md#net_socket_buffersize +[`timeout.ref()`]: timers.md#timers_timeout_ref +[`timeout.refresh()`]: timers.md#timers_timeout_refresh +[`timeout.unref()`]: timers.md#timers_timeout_unref +[`tls.CryptoStream`]: tls.md#tls_class_tls_cryptostream +[`tls.SecureContext`]: tls.md#tls_tls_createsecurecontext_options +[`tls.SecurePair`]: tls.md#tls_class_tls_securepair +[`tls.TLSSocket`]: tls.md#tls_class_tls_tlssocket +[`tls.checkServerIdentity()`]: tls.md#tls_tls_checkserveridentity_hostname_cert +[`tls.createSecureContext()`]: tls.md#tls_tls_createsecurecontext_options +[`url.format()`]: url.md#url_url_format_urlobject +[`url.parse()`]: url.md#url_url_parse_urlstring_parsequerystring_slashesdenotehost +[`url.resolve()`]: url.md#url_url_resolve_from_to +[`util._extend()`]: util.md#util_util_extend_target_source +[`util.getSystemErrorName()`]: util.md#util_util_getsystemerrorname_err +[`util.inspect()`]: util.md#util_util_inspect_object_options +[`util.inspect.custom`]: util.md#util_util_inspect_custom +[`util.isArray()`]: util.md#util_util_isarray_object +[`util.isBoolean()`]: util.md#util_util_isboolean_object +[`util.isBuffer()`]: util.md#util_util_isbuffer_object +[`util.isDate()`]: util.md#util_util_isdate_object +[`util.isError()`]: util.md#util_util_iserror_object +[`util.isFunction()`]: util.md#util_util_isfunction_object +[`util.isNull()`]: util.md#util_util_isnull_object +[`util.isNullOrUndefined()`]: util.md#util_util_isnullorundefined_object +[`util.isNumber()`]: util.md#util_util_isnumber_object +[`util.isObject()`]: util.md#util_util_isobject_object +[`util.isPrimitive()`]: util.md#util_util_isprimitive_object +[`util.isRegExp()`]: util.md#util_util_isregexp_object +[`util.isString()`]: util.md#util_util_isstring_object +[`util.isSymbol()`]: util.md#util_util_issymbol_object +[`util.isUndefined()`]: util.md#util_util_isundefined_object +[`util.log()`]: util.md#util_util_log_string +[`util.types`]: util.md#util_util_types +[`util`]: util.md +[`worker.exitedAfterDisconnect`]: cluster.md#cluster_worker_exitedafterdisconnect +[`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.html#url_the_whatwg_url_api -[alloc]: buffer.html#buffer_static_method_buffer_alloc_size_fill_encoding -[alloc_unsafe_size]: buffer.html#buffer_static_method_buffer_allocunsafe_size -[from_arraybuffer]: buffer.html#buffer_static_method_buffer_from_arraybuffer_byteoffset_length -[from_string_encoding]: buffer.html#buffer_static_method_buffer_from_string_encoding -[legacy `urlObject`]: url.html#url_legacy_urlobject -[static methods of `crypto.Certificate()`]: crypto.html#crypto_class_certificate +[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 +[from_string_encoding]: buffer.md#buffer_static_method_buffer_from_string_encoding +[legacy `urlObject`]: url.md#url_legacy_urlobject +[static methods of `crypto.Certificate()`]: crypto.md#crypto_class_certificate diff --git a/doc/api/dgram.md b/doc/api/dgram.md index 3ed4e55e2a..e1c5ace6b0 100644 --- a/doc/api/dgram.md +++ b/doc/api/dgram.md @@ -786,20 +786,20 @@ and `udp6` sockets). The bound address and port can be retrieved using [`socket.address().address`][] and [`socket.address().port`][]. [`'close'`]: #dgram_event_close -[`ERR_SOCKET_BAD_PORT`]: errors.html#errors_err_socket_bad_port -[`ERR_SOCKET_BUFFER_SIZE`]: errors.html#errors_err_socket_buffer_size -[`ERR_SOCKET_DGRAM_IS_CONNECTED`]: errors.html#errors_err_socket_dgram_is_connected -[`ERR_SOCKET_DGRAM_NOT_CONNECTED`]: errors.html#errors_err_socket_dgram_not_connected -[`Error`]: errors.html#errors_class_error -[`System Error`]: errors.html#errors_class_systemerror +[`ERR_SOCKET_BAD_PORT`]: errors.md#errors_err_socket_bad_port +[`ERR_SOCKET_BUFFER_SIZE`]: errors.md#errors_err_socket_buffer_size +[`ERR_SOCKET_DGRAM_IS_CONNECTED`]: errors.md#errors_err_socket_dgram_is_connected +[`ERR_SOCKET_DGRAM_NOT_CONNECTED`]: errors.md#errors_err_socket_dgram_not_connected +[`Error`]: errors.md#errors_class_error +[`System Error`]: errors.md#errors_class_systemerror [`close()`]: #dgram_socket_close_callback -[`cluster`]: cluster.html +[`cluster`]: cluster.md [`connect()`]: #dgram_socket_connect_port_address_callback [`dgram.createSocket()`]: #dgram_dgram_createsocket_options_callback -[`dns.lookup()`]: dns.html#dns_dns_lookup_hostname_options_callback +[`dns.lookup()`]: dns.md#dns_dns_lookup_hostname_options_callback [`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.html#buffer_static_method_buffer_bytelength_string_encoding +[byte length]: buffer.md#buffer_static_method_buffer_bytelength_string_encoding diff --git a/doc/api/dns.md b/doc/api/dns.md index e5ad6544a9..e8ab1c917b 100644 --- a/doc/api/dns.md +++ b/doc/api/dns.md @@ -1160,9 +1160,9 @@ 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`_. -[`Error`]: errors.html#errors_class_error -[`UV_THREADPOOL_SIZE`]: cli.html#cli_uv_threadpool_size_size -[`dgram.createSocket()`]: dgram.html#dgram_dgram_createsocket_options_callback +[`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 [`dns.getServers()`]: #dns_dns_getservers [`dns.lookup()`]: #dns_dns_lookup_hostname_options_callback [`dns.resolve()`]: #dns_dns_resolve_hostname_rrtype_callback @@ -1195,8 +1195,8 @@ uses. For instance, _they do not use the configuration from `/etc/hosts`_. [`dnsPromises.resolveTxt()`]: #dns_dnspromises_resolvetxt_hostname [`dnsPromises.reverse()`]: #dns_dnspromises_reverse_ip [`dnsPromises.setServers()`]: #dns_dnspromises_setservers_servers -[`socket.connect()`]: net.html#net_socket_connect_options_connectlistener -[`util.promisify()`]: util.html#util_util_promisify_original +[`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 diff --git a/doc/api/documentation.md b/doc/api/documentation.md index 779b02d14c..bdc3466152 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -63,4 +63,4 @@ be unavoidable. [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.html#process_event_warning +[warning]: process.md#process_event_warning diff --git a/doc/api/domain.md b/doc/api/domain.md index 0b79ec5b37..ccfbc25850 100644 --- a/doc/api/domain.md +++ b/doc/api/domain.md @@ -478,10 +478,10 @@ Domains will not interfere with the error handling mechanisms for promises. In other words, no `'error'` event will be emitted for unhandled `Promise` rejections. -[`Error`]: errors.html#errors_class_error +[`Error`]: errors.md#errors_class_error [`domain.add(emitter)`]: #domain_domain_add_emitter [`domain.bind(callback)`]: #domain_domain_bind_callback [`domain.exit()`]: #domain_domain_exit -[`setInterval()`]: timers.html#timers_setinterval_callback_delay_args -[`setTimeout()`]: timers.html#timers_settimeout_callback_delay_args +[`setInterval()`]: timers.md#timers_setinterval_callback_delay_args +[`setTimeout()`]: timers.md#timers_settimeout_callback_delay_args [`throw`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/throw diff --git a/doc/api/embedding.md b/doc/api/embedding.md index cb225a1eb9..d18b3d9141 100644 --- a/doc/api/embedding.md +++ b/doc/api/embedding.md @@ -220,8 +220,8 @@ int RunNodeInstance(MultiIsolatePlatform* platform, } ``` -[`process.memoryUsage()`]: process.html#process_process_memoryusage -[CLI options]: cli.html -[deprecation policy]: deprecations.html +[`process.memoryUsage()`]: process.md#process_process_memoryusage +[CLI options]: cli.md +[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 8022cba4d3..2816323c1d 100644 --- a/doc/api/errors.md +++ b/doc/api/errors.md @@ -2580,82 +2580,82 @@ removed: v10.0.0 Used when an attempt is made to use a `zlib` object after it has already been closed. -[`'uncaughtException'`]: process.html#process_event_uncaughtexception -[`--disable-proto=throw`]: cli.html#cli_disable_proto_mode -[`--force-fips`]: cli.html#cli_force_fips -[`Class: assert.AssertionError`]: assert.html#assert_class_assert_assertionerror +[`'uncaughtException'`]: process.md#process_event_uncaughtexception +[`--disable-proto=throw`]: cli.md#cli_disable_proto_mode +[`--force-fips`]: cli.md#cli_force_fips +[`Class: assert.AssertionError`]: assert.md#assert_class_assert_assertionerror [`ERR_INVALID_ARG_TYPE`]: #ERR_INVALID_ARG_TYPE [`ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST`]: #ERR_MISSING_MESSAGE_PORT_IN_TRANSFER_LIST [`ERR_MISSING_TRANSFERABLE_IN_TRANSFER_LIST`]: #ERR_MISSING_TRANSFERABLE_IN_TRANSFER_LIST -[`EventEmitter`]: events.html#events_class_eventemitter -[`MessagePort`]: worker_threads.html#worker_threads_class_messageport +[`EventEmitter`]: events.md#events_class_eventemitter +[`MessagePort`]: worker_threads.md#worker_threads_class_messageport [`Object.getPrototypeOf`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/getPrototypeOf [`Object.setPrototypeOf`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/setPrototypeOf -[`REPL`]: repl.html -[`Writable`]: stream.html#stream_class_stream_writable -[`child_process`]: child_process.html -[`cipher.getAuthTag()`]: crypto.html#crypto_cipher_getauthtag -[`crypto.getDiffieHellman()`]: crypto.html#crypto_crypto_getdiffiehellman_groupname -[`crypto.scrypt()`]: crypto.html#crypto_crypto_scrypt_password_salt_keylen_options_callback -[`crypto.scryptSync()`]: crypto.html#crypto_crypto_scryptsync_password_salt_keylen_options -[`crypto.timingSafeEqual()`]: crypto.html#crypto_crypto_timingsafeequal_a_b -[`dgram.connect()`]: dgram.html#dgram_socket_connect_port_address_callback -[`dgram.createSocket()`]: dgram.html#dgram_dgram_createsocket_options_callback -[`dgram.disconnect()`]: dgram.html#dgram_socket_disconnect -[`dgram.remoteAddress()`]: dgram.html#dgram_socket_remoteaddress +[`REPL`]: repl.md +[`Writable`]: stream.md#stream_class_stream_writable +[`child_process`]: child_process.md +[`cipher.getAuthTag()`]: crypto.md#crypto_cipher_getauthtag +[`crypto.getDiffieHellman()`]: crypto.md#crypto_crypto_getdiffiehellman_groupname +[`crypto.scrypt()`]: crypto.md#crypto_crypto_scrypt_password_salt_keylen_options_callback +[`crypto.scryptSync()`]: crypto.md#crypto_crypto_scryptsync_password_salt_keylen_options +[`crypto.timingSafeEqual()`]: crypto.md#crypto_crypto_timingsafeequal_a_b +[`dgram.connect()`]: dgram.md#dgram_socket_connect_port_address_callback +[`dgram.createSocket()`]: dgram.md#dgram_dgram_createsocket_options_callback +[`dgram.disconnect()`]: dgram.md#dgram_socket_disconnect +[`dgram.remoteAddress()`]: dgram.md#dgram_socket_remoteaddress [`errno`(3) man page]: https://man7.org/linux/man-pages/man3/errno.3.html -[`fs.Dir`]: fs.html#fs_class_fs_dir -[`fs.readFileSync`]: fs.html#fs_fs_readfilesync_path_options -[`fs.readdir`]: fs.html#fs_fs_readdir_path_options_callback -[`fs.symlink()`]: fs.html#fs_fs_symlink_target_path_type_callback -[`fs.symlinkSync()`]: fs.html#fs_fs_symlinksync_target_path_type -[`fs.unlink`]: fs.html#fs_fs_unlink_path_callback -[`fs`]: fs.html -[`hash.digest()`]: crypto.html#crypto_hash_digest_encoding -[`hash.update()`]: crypto.html#crypto_hash_update_data_inputencoding -[`http`]: http.html -[`https`]: https.html +[`fs.Dir`]: fs.md#fs_class_fs_dir +[`fs.readFileSync`]: fs.md#fs_fs_readfilesync_path_options +[`fs.readdir`]: fs.md#fs_fs_readdir_path_options_callback +[`fs.symlink()`]: fs.md#fs_fs_symlink_target_path_type_callback +[`fs.symlinkSync()`]: fs.md#fs_fs_symlinksync_target_path_type +[`fs.unlink`]: fs.md#fs_fs_unlink_path_callback +[`fs`]: fs.md +[`hash.digest()`]: crypto.md#crypto_hash_digest_encoding +[`hash.update()`]: crypto.md#crypto_hash_update_data_inputencoding +[`http`]: http.md +[`https`]: https.md [`libuv Error handling`]: https://docs.libuv.org/en/v1.x/errors.html -[`net`]: net.html -[`new URL(input)`]: url.html#url_new_url_input_base -[`new URLSearchParams(iterable)`]: url.html#url_new_urlsearchparams_iterable -[`postMessage()`]: worker_threads.html#worker_threads_port_postmessage_value_transferlist -[`process.on('exit')`]: process.html#Event:-`'exit'` -[`process.send()`]: process.html#process_process_send_message_sendhandle_options_callback -[`process.setUncaughtExceptionCaptureCallback()`]: process.html#process_process_setuncaughtexceptioncapturecallback_fn -[`readable._read()`]: stream.html#stream_readable_read_size_1 -[`require('crypto').setEngine()`]: crypto.html#crypto_crypto_setengine_engine_flags -[`require()`]: modules.html#modules_require_id -[`server.close()`]: net.html#net_server_close_callback -[`server.listen()`]: net.html#net_server_listen -[`sign.sign()`]: crypto.html#crypto_sign_sign_privatekey_outputencoding -[`stream.pipe()`]: stream.html#stream_readable_pipe_destination_options -[`stream.push()`]: stream.html#stream_readable_push_chunk_encoding -[`stream.unshift()`]: stream.html#stream_readable_unshift_chunk_encoding -[`stream.write()`]: stream.html#stream_writable_write_chunk_encoding_callback -[`subprocess.kill()`]: child_process.html#child_process_subprocess_kill_signal -[`subprocess.send()`]: child_process.html#child_process_subprocess_send_message_sendhandle_options_callback -[`util.getSystemErrorName(error.errno)`]: util.html#util_util_getsystemerrorname_err -[`zlib`]: zlib.html -[ES Module]: esm.html -[ICU]: intl.html#intl_internationalization_support +[`net`]: net.md +[`new URL(input)`]: url.md#url_new_url_input_base +[`new URLSearchParams(iterable)`]: url.md#url_new_urlsearchparams_iterable +[`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 +[`process.setUncaughtExceptionCaptureCallback()`]: process.md#process_process_setuncaughtexceptioncapturecallback_fn +[`readable._read()`]: stream.md#stream_readable_read_size_1 +[`require('crypto').setEngine()`]: crypto.md#crypto_crypto_setengine_engine_flags +[`require()`]: modules.md#modules_require_id +[`server.close()`]: net.md#net_server_close_callback +[`server.listen()`]: net.md#net_server_listen +[`sign.sign()`]: crypto.md#crypto_sign_sign_privatekey_outputencoding +[`stream.pipe()`]: stream.md#stream_readable_pipe_destination_options +[`stream.push()`]: stream.md#stream_readable_push_chunk_encoding +[`stream.unshift()`]: stream.md#stream_readable_unshift_chunk_encoding +[`stream.write()`]: stream.md#stream_writable_write_chunk_encoding_callback +[`subprocess.kill()`]: child_process.md#child_process_subprocess_kill_signal +[`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.html#util_whatwg_supported_encodings -[WHATWG URL API]: url.html#url_the_whatwg_url_api -[crypto digest algorithm]: crypto.html#crypto_crypto_gethashes -[domains]: domain.html -[event emitter-based]: events.html#events_class_eventemitter -[`package.json`]: packages.html#packages_node_js_package_json_field_definitions -[`"exports"`]: packages.html#packages_exports +[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 +[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.html +[policy]: policy.md [RFC 7230 Section 3]: https://tools.ietf.org/html/rfc7230#section-3 -[stream-based]: stream.html +[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.html -[self-reference a package using its name]: packages.html#packages_self_referencing_a_package_using_its_name -[define a custom subpath]: packages.html#packages_subpath_exports -[`"imports"`]: packages.html#packages_imports +[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 db77d24628..c24ed61b9b 100644 --- a/doc/api/esm.md +++ b/doc/api/esm.md @@ -57,7 +57,7 @@ Node.js treats JavaScript code as CommonJS modules by default. Authors can tell Node.js to treat JavaScript code as ECMAScript modules via the `.mjs` file extension, the `package.json` [`"type"`][] field, or the `--input-type` flag. See -[Modules: Packages](packages.html#packages_determining_module_system) for more +[Modules: Packages](packages.md#packages_determining_module_system) for more details. @@ -78,7 +78,7 @@ details. ## Packages -This section was moved to [Modules: Packages](packages.html). +This section was moved to [Modules: Packages](packages.md). ## `import` Specifiers @@ -1229,8 +1229,8 @@ success! ``` -[CommonJS]: modules.html -[Conditional exports]: packages.html#packages_conditional_exports +[CommonJS]: modules.md +[Conditional exports]: packages.md#packages_conditional_exports [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/ @@ -1243,22 +1243,22 @@ success! [`import()`]: #esm_import_expressions [`import.meta.url`]: #esm_import_meta [`import`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import -[`module.createRequire()`]: module.html#module_module_createrequire_filename -[`module.syncBuiltinESMExports()`]: module.html#module_module_syncbuiltinesmexports +[`module.createRequire()`]: module.md#module_module_createrequire_filename +[`module.syncBuiltinESMExports()`]: module.md#module_module_syncbuiltinesmexports [`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.html#util_class_util_textdecoder +[`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.html#modules_core_modules -[`package.json`]: packages.html#packages_node_js_package_json_field_definitions -[`"exports"`]: packages.html#packages_exports -[`"type"`]: packages.html#packages_type +[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 4923b874a0..9d46d8a8dd 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -1526,19 +1526,19 @@ and `removeEventListener()` is that `removeListener()` will return a reference to the `EventTarget`. [WHATWG-EventTarget]: https://dom.spec.whatwg.org/#interface-eventtarget -[`--trace-warnings`]: cli.html#cli_trace_warnings +[`--trace-warnings`]: cli.md#cli_trace_warnings [`EventEmitter.defaultMaxListeners`]: #events_eventemitter_defaultmaxlisteners -[`domain`]: domain.html +[`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.html#fs_class_fs_readstream -[`net.Server`]: net.html#net_class_net_server -[`process.on('warning')`]: process.html#process_event_warning -[stream]: stream.html +[`fs.ReadStream`]: fs.md#fs_class_fs_readstream +[`net.Server`]: net.md#net_class_net_server +[`process.on('warning')`]: process.md#process_event_warning +[stream]: stream.md [capturerejections]: #events_capture_rejections_of_promises [rejection]: #events_emitter_symbol_for_nodejs_rejection_err_eventname_args [rejectionsymbol]: #events_events_capturerejectionsymbol diff --git a/doc/api/fs.md b/doc/api/fs.md index 04228d345d..cef7d608f3 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -5961,15 +5961,15 @@ A call to `fs.ftruncate()` or `filehandle.truncate()` can be used to reset the file contents. [`AHAFS`]: https://www.ibm.com/developerworks/aix/library/au-aix_event_infrastructure/ -[`Buffer.byteLength`]: buffer.html#buffer_static_method_buffer_bytelength_string_encoding -[`Buffer`]: buffer.html#buffer_buffer +[`Buffer.byteLength`]: buffer.md#buffer_static_method_buffer_bytelength_string_encoding +[`Buffer`]: buffer.md#buffer_buffer [`FSEvents`]: https://developer.apple.com/documentation/coreservices/file_system_events [`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.html#stream_class_stream_readable -[`URL`]: url.html#url_the_whatwg_url_api -[`UV_THREADPOOL_SIZE`]: cli.html#cli_uv_threadpool_size_size +[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 [`event ports`]: https://illumos.org/man/port_create [`filehandle.writeFile()`]: #fs_filehandle_writefile_data_options @@ -5983,7 +5983,7 @@ the file contents. [`fs.copyFile()`]: #fs_fs_copyfile_src_dest_mode_callback [`fs.createReadStream()`]: #fs_fs_createreadstream_path_options [`fs.createWriteStream()`]: #fs_fs_createwritestream_path_options -[`fs.exists()`]: fs.html#fs_fs_exists_path_callback +[`fs.exists()`]: fs.md#fs_fs_exists_path_callback [`fs.fstat()`]: #fs_fs_fstat_fd_options_callback [`fs.ftruncate()`]: #fs_fs_ftruncate_fd_len_callback [`fs.futimes()`]: #fs_fs_futimes_fd_atime_mtime_callback @@ -6015,11 +6015,11 @@ the file contents. [`fsPromises.utimes()`]: #fs_fspromises_utimes_path_atime_mtime [`inotify(7)`]: https://man7.org/linux/man-pages/man7/inotify.7.html [`kqueue(2)`]: https://www.freebsd.org/cgi/man.cgi?query=kqueue&sektion=2 -[`net.Socket`]: net.html#net_class_net_socket -[`stat()`]: fs.html#fs_fs_stat_path_options_callback -[`util.promisify()`]: util.html#util_util_promisify_original +[`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.html#errors_common_system_errors +[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 @@ -6031,4 +6031,4 @@ the file contents. [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.html#stream_class_stream_writable +[Writable Stream]: stream.md#stream_class_stream_writable diff --git a/doc/api/globals.md b/doc/api/globals.md index 4844c86134..8b279a2171 100644 --- a/doc/api/globals.md +++ b/doc/api/globals.md @@ -322,27 +322,27 @@ The object that acts as the namespace for all W3C [Mozilla Developer Network][webassembly-mdn] for usage and compatibility. [`AbortController`]: https://developer.mozilla.org/en-US/docs/Web/API/AbortController -[`TextDecoder`]: util.html#util_class_util_textdecoder -[`TextEncoder`]: util.html#util_class_util_textencoder -[`URLSearchParams`]: url.html#url_class_urlsearchparams -[`URL`]: url.html#url_class_url -[`__dirname`]: modules.html#modules_dirname -[`__filename`]: modules.html#modules_filename -[`clearImmediate`]: timers.html#timers_clearimmediate_immediate -[`clearInterval`]: timers.html#timers_clearinterval_timeout -[`clearTimeout`]: timers.html#timers_cleartimeout_timeout -[`console`]: console.html -[`exports`]: modules.html#modules_exports -[`module`]: modules.html#modules_module -[`process.nextTick()`]: process.html#process_process_nexttick_callback_args -[`process` object]: process.html#process_process -[`require()`]: modules.html#modules_require_id -[`setImmediate`]: timers.html#timers_setimmediate_callback_args -[`setInterval`]: timers.html#timers_setinterval_callback_delay_args -[`setTimeout`]: timers.html#timers_settimeout_callback_delay_args -[buffer section]: buffer.html +[`TextDecoder`]: util.md#util_class_util_textdecoder +[`TextEncoder`]: util.md#util_class_util_textencoder +[`URLSearchParams`]: url.md#url_class_urlsearchparams +[`URL`]: url.md#url_class_url +[`__dirname`]: modules.md#modules_dirname +[`__filename`]: modules.md#modules_filename +[`clearImmediate`]: timers.md#timers_clearimmediate_immediate +[`clearInterval`]: timers.md#timers_clearinterval_timeout +[`clearTimeout`]: timers.md#timers_cleartimeout_timeout +[`console`]: console.md +[`exports`]: modules.md#modules_exports +[`module`]: modules.md#modules_module +[`process.nextTick()`]: process.md#process_process_nexttick_callback_args +[`process` object]: process.md#process_process +[`require()`]: modules.md#modules_require_id +[`setImmediate`]: timers.md#timers_setimmediate_callback_args +[`setInterval`]: timers.md#timers_setinterval_callback_delay_args +[`setTimeout`]: timers.md#timers_settimeout_callback_delay_args +[buffer section]: buffer.md [built-in objects]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects -[module system documentation]: modules.html -[timers]: timers.html +[module system documentation]: modules.md +[timers]: timers.md [webassembly-mdn]: https://developer.mozilla.org/en-US/docs/WebAssembly [webassembly-org]: https://webassembly.org diff --git a/doc/api/http.md b/doc/api/http.md index b4348f4dfd..9d1d5b528c 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -133,7 +133,7 @@ changes: options are respectively set to `false` and `Infinity`, in which case `Connection: close` will be used. **Default:** `false`. * `keepAliveMsecs` {number} When using the `keepAlive` option, specifies - the [initial delay](net.html#net_socket_setkeepalive_enable_initialdelay) + the [initial delay](net.md#net_socket_setkeepalive_enable_initialdelay) for TCP Keep-Alive packets. Ignored when the `keepAlive` option is `false` or `undefined`. **Default:** `1000`. * `maxSockets` {number} Maximum number of sockets to allow per @@ -2646,23 +2646,23 @@ try { } ``` -[`--insecure-http-parser`]: cli.html#cli_insecure_http_parser -[`--max-http-header-size`]: cli.html#cli_max_http_header_size_size +[`--insecure-http-parser`]: cli.md#cli_insecure_http_parser +[`--max-http-header-size`]: cli.md#cli_max_http_header_size_size [`'checkContinue'`]: #http_event_checkcontinue [`'finish'`]: #http_event_finish [`'request'`]: #http_event_request [`'response'`]: #http_event_response [`'upgrade'`]: #http_event_upgrade [`Agent`]: #http_class_http_agent -[`Buffer.byteLength()`]: buffer.html#buffer_static_method_buffer_bytelength_string_encoding -[`Duplex`]: stream.html#stream_class_stream_duplex -[`HPE_HEADER_OVERFLOW`]: errors.html#errors_hpe_header_overflow -[`TypeError`]: errors.html#errors_class_typeerror -[`URL`]: url.html#url_the_whatwg_url_api +[`Buffer.byteLength()`]: buffer.md#buffer_static_method_buffer_bytelength_string_encoding +[`Duplex`]: stream.md#stream_class_stream_duplex +[`HPE_HEADER_OVERFLOW`]: errors.md#errors_hpe_header_overflow +[`TypeError`]: errors.md#errors_class_typeerror +[`URL`]: url.md#url_the_whatwg_url_api [`agent.createConnection()`]: #http_agent_createconnection_options_callback [`agent.getName()`]: #http_agent_getname_options [`destroy()`]: #http_agent_destroy -[`dns.lookup()`]: dns.html#dns_dns_lookup_hostname_options_callback +[`dns.lookup()`]: dns.md#dns_dns_lookup_hostname_options_callback [`getHeader(name)`]: #http_request_getheader_name [`http.Agent`]: #http_class_http_agent [`http.ClientRequest`]: #http_class_http_clientrequest @@ -2672,11 +2672,11 @@ try { [`http.globalAgent`]: #http_http_globalagent [`http.request()`]: #http_http_request_options_callback [`message.headers`]: #http_message_headers -[`net.Server.close()`]: net.html#net_server_close_callback -[`net.Server`]: net.html#net_class_net_server -[`net.Socket`]: net.html#net_class_net_socket -[`net.createConnection()`]: net.html#net_net_createconnection_options_connectlistener -[`new URL()`]: url.html#url_new_url_input_base +[`net.Server.close()`]: net.md#net_server_close_callback +[`net.Server`]: net.md#net_class_net_server +[`net.Socket`]: net.md#net_class_net_socket +[`net.createConnection()`]: net.md#net_net_createconnection_options_connectlistener +[`new URL()`]: url.md#url_new_url_input_base [`removeHeader(name)`]: #http_request_removeheader_name [`request.end()`]: #http_request_end_data_encoding_callback [`request.destroy()`]: #http_request_destroy_error @@ -2684,7 +2684,7 @@ try { [`request.getHeader()`]: #http_request_getheader_name [`request.setHeader()`]: #http_request_setheader_name_value [`request.setTimeout()`]: #http_request_settimeout_timeout_callback -[`request.socket.getPeerCertificate()`]: tls.html#tls_tlssocket_getpeercertificate_detailed +[`request.socket.getPeerCertificate()`]: tls.md#tls_tlssocket_getpeercertificate_detailed [`request.socket`]: #http_request_socket [`request.writableFinished`]: #http_request_writablefinished [`request.writableEnded`]: #http_request_writableended @@ -2699,16 +2699,16 @@ try { [`response.write(data, encoding)`]: #http_response_write_chunk_encoding_callback [`response.writeContinue()`]: #http_response_writecontinue [`response.writeHead()`]: #http_response_writehead_statuscode_statusmessage_headers -[`server.listen()`]: net.html#net_server_listen +[`server.listen()`]: net.md#net_server_listen [`server.timeout`]: #http_server_timeout [`setHeader(name, value)`]: #http_request_setheader_name_value -[`socket.connect()`]: net.html#net_socket_connect_options_connectlistener -[`socket.setKeepAlive()`]: net.html#net_socket_setkeepalive_enable_initialdelay -[`socket.setNoDelay()`]: net.html#net_socket_setnodelay_nodelay -[`socket.setTimeout()`]: net.html#net_socket_settimeout_timeout_callback -[`socket.unref()`]: net.html#net_socket_unref -[`url.parse()`]: url.html#url_url_parse_urlstring_parsequerystring_slashesdenotehost -[`writable.destroy()`]: stream.html#stream_writable_destroy_error -[`writable.destroyed`]: stream.html#stream_writable_destroyed -[`writable.cork()`]: stream.html#stream_writable_cork -[`writable.uncork()`]: stream.html#stream_writable_uncork +[`socket.connect()`]: net.md#net_socket_connect_options_connectlistener +[`socket.setKeepAlive()`]: net.md#net_socket_setkeepalive_enable_initialdelay +[`socket.setNoDelay()`]: net.md#net_socket_setnodelay_nodelay +[`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.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 31c80564dd..47ec107024 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -3706,13 +3706,13 @@ you need to implement any fall-back behaviour yourself. [ALPN Protocol ID]: https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids [ALPN negotiation]: #http2_alpn_negotiation [Compatibility API]: #http2_compatibility_api -[HTTP/1]: http.html +[HTTP/1]: http.md [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.html -[Performance Observer]: perf_hooks.html +[HTTPS]: https.md +[Performance Observer]: perf_hooks.md [RFC 7838]: https://tools.ietf.org/html/rfc7838 [RFC 8336]: https://tools.ietf.org/html/rfc8336 [RFC 8441]: https://tools.ietf.org/html/rfc8441 @@ -3721,43 +3721,43 @@ you need to implement any fall-back behaviour yourself. [`'request'`]: #http2_event_request [`'unknownProtocol'`]: #http2_event_unknownprotocol [`ClientHttp2Stream`]: #http2_class_clienthttp2stream -[`Duplex`]: stream.html#stream_class_stream_duplex +[`Duplex`]: stream.md#stream_class_stream_duplex [`Http2ServerRequest`]: #http2_class_http2_http2serverrequest [`Http2ServerResponse`]: #http2_class_http2_http2serverresponse [`Http2Session` and Sockets]: #http2_http2session_and_sockets [`Http2Stream`]: #http2_class_http2stream [`ServerHttp2Stream`]: #http2_class_serverhttp2stream -[`TypeError`]: errors.html#errors_class_typeerror -[`http.ClientRequest#maxHeadersCount`]: http.html#http_request_maxheaderscount -[`http.Server#maxHeadersCount`]: http.html#http_server_maxheaderscount +[`TypeError`]: errors.md#errors_class_typeerror +[`http.ClientRequest#maxHeadersCount`]: http.md#http_request_maxheaderscount +[`http.Server#maxHeadersCount`]: http.md#http_server_maxheaderscount [`http2.SecureServer`]: #http2_class_http2secureserver [`http2.Server`]: #http2_class_http2server [`http2.createSecureServer()`]: #http2_http2_createsecureserver_options_onrequesthandler [`http2.createServer()`]: #http2_http2_createserver_options_onrequesthandler [`http2session.close()`]: #http2_http2session_close_callback [`http2stream.pushStream()`]: #http2_http2stream_pushstream_headers_options_callback -[`net.createServer()`]: net.html#net_net_createserver_options_connectionlistener -[`net.Server.close()`]: net.html#net_server_close_callback -[`net.Socket.bufferSize`]: net.html#net_socket_buffersize -[`net.Socket.prototype.ref()`]: net.html#net_socket_ref -[`net.Socket.prototype.unref()`]: net.html#net_socket_unref -[`net.Socket`]: net.html#net_class_net_socket -[`net.connect()`]: net.html#net_net_connect +[`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 [`request.authority`]: #http2_request_authority [`request.socket`]: #http2_request_socket -[`request.socket.getPeerCertificate()`]: tls.html#tls_tlssocket_getpeercertificate_detailed +[`request.socket.getPeerCertificate()`]: tls.md#tls_tlssocket_getpeercertificate_detailed [`response.end()`]: #http2_response_end_data_encoding_callback [`response.setHeader()`]: #http2_response_setheader_name_value [`response.socket`]: #http2_response_socket [`response.writableEnded`]: #http2_response_writableended [`response.write()`]: #http2_response_write_chunk_encoding_callback -[`response.write(data, encoding)`]: http.html#http_response_write_chunk_encoding_callback +[`response.write(data, encoding)`]: http.md#http_response_write_chunk_encoding_callback [`response.writeContinue()`]: #http2_response_writecontinue [`response.writeHead()`]: #http2_response_writehead_statuscode_statusmessage_headers -[`tls.Server.close()`]: tls.html#tls_server_close_callback -[`tls.TLSSocket`]: tls.html#tls_class_tls_tlssocket -[`tls.connect()`]: tls.html#tls_tls_connect_options_callback -[`tls.createServer()`]: tls.html#tls_tls_createserver_options_secureconnectionlistener -[`writable.writableFinished`]: stream.html#stream_writable_writablefinished +[`tls.Server.close()`]: tls.md#tls_server_close_callback +[`tls.TLSSocket`]: tls.md#tls_class_tls_tlssocket +[`tls.connect()`]: tls.md#tls_tls_connect_options_callback +[`tls.createServer()`]: tls.md#tls_tls_createserver_options_secureconnectionlistener +[`writable.writableFinished`]: stream.md#stream_writable_writablefinished [error code]: #http2_error_codes_for_rst_stream_and_goaway [Sensitive headers]: #http2_sensitive_headers diff --git a/doc/api/https.md b/doc/api/https.md index 40dcf4b1d7..b7f2f2b1e1 100644 --- a/doc/api/https.md +++ b/doc/api/https.md @@ -454,27 +454,27 @@ headers: max-age=0; pin-sha256="WoiWRyIOVNa9ihaBciRSC7XHjliYS9VwUGOIud4PB18="; p ``` [`Agent`]: #https_class_https_agent -[`URL`]: url.html#url_the_whatwg_url_api -[`http.Agent`]: http.html#http_class_http_agent -[`http.Agent(options)`]: http.html#http_new_agent_options -[`http.Server#headersTimeout`]: http.html#http_server_headerstimeout -[`http.Server#keepAliveTimeout`]: http.html#http_server_keepalivetimeout -[`http.Server#maxHeadersCount`]: http.html#http_server_maxheaderscount -[`http.Server#requestTimeout`]: http.html#http_server_requesttimeout -[`http.Server#setTimeout()`]: http.html#http_server_settimeout_msecs_callback -[`http.Server#timeout`]: http.html#http_server_timeout -[`http.Server`]: http.html#http_class_http_server -[`http.close()`]: http.html#http_server_close_callback -[`http.createServer()`]: http.html#http_http_createserver_options_requestlistener -[`http.get()`]: http.html#http_http_get_options_callback -[`http.request()`]: http.html#http_http_request_options_callback +[`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.Server#headersTimeout`]: http.md#http_server_headerstimeout +[`http.Server#keepAliveTimeout`]: http.md#http_server_keepalivetimeout +[`http.Server#maxHeadersCount`]: http.md#http_server_maxheaderscount +[`http.Server#requestTimeout`]: http.md#http_server_requesttimeout +[`http.Server#setTimeout()`]: http.md#http_server_settimeout_msecs_callback +[`http.Server#timeout`]: http.md#http_server_timeout +[`http.Server`]: http.md#http_class_http_server +[`http.close()`]: http.md#http_server_close_callback +[`http.createServer()`]: http.md#http_http_createserver_options_requestlistener +[`http.get()`]: http.md#http_http_get_options_callback +[`http.request()`]: http.md#http_http_request_options_callback [`https.Agent`]: #https_class_https_agent [`https.request()`]: #https_https_request_options_callback -[`net.Server`]: net.html#net_class_net_server -[`new URL()`]: url.html#url_new_url_input_base -[`server.listen()`]: net.html#net_server_listen -[`tls.connect()`]: tls.html#tls_tls_connect_options_callback -[`tls.createSecureContext()`]: tls.html#tls_tls_createsecurecontext_options -[`tls.createServer()`]: tls.html#tls_tls_createserver_options_secureconnectionlistener -[`Session Resumption`]: tls.html#tls_session_resumption +[`net.Server`]: net.md#net_class_net_server +[`new URL()`]: url.md#url_new_url_input_base +[`server.listen()`]: net.md#net_server_listen +[`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/index.md b/doc/api/index.md index aad731f2b9..aadd5b4c79 100644 --- a/doc/api/index.md +++ b/doc/api/index.md @@ -5,65 +5,65 @@ -* [About this documentation](documentation.html) -* [Usage and example](synopsis.html) +* [About this documentation](documentation.md) +* [Usage and example](synopsis.md)
-* [Assertion testing](assert.html) -* [Async hooks](async_hooks.html) -* [Buffer](buffer.html) -* [C++ addons](addons.html) -* [C/C++ addons with N-API](n-api.html) -* [C++ embedder API](embedding.html) -* [Child processes](child_process.html) -* [Cluster](cluster.html) -* [Command-line options](cli.html) -* [Console](console.html) -* [Crypto](crypto.html) -* [Debugger](debugger.html) -* [Deprecated APIs](deprecations.html) -* [DNS](dns.html) -* [Domain](domain.html) -* [Errors](errors.html) -* [Events](events.html) -* [File system](fs.html) -* [Globals](globals.html) -* [HTTP](http.html) -* [HTTP/2](http2.html) -* [HTTPS](https.html) -* [Inspector](inspector.html) -* [Internationalization](intl.html) -* [Modules: CommonJS modules](modules.html) -* [Modules: ECMAScript modules](esm.html) -* [Modules: `module` API](module.html) -* [Modules: Packages](packages.html) -* [Net](net.html) -* [OS](os.html) -* [Path](path.html) -* [Performance hooks](perf_hooks.html) -* [Policies](policy.html) -* [Process](process.html) -* [Punycode](punycode.html) -* [Query strings](querystring.html) -* [QUIC](quic.html) -* [Readline](readline.html) -* [REPL](repl.html) -* [Report](report.html) -* [Stream](stream.html) -* [String decoder](string_decoder.html) -* [Timers](timers.html) -* [TLS/SSL](tls.html) -* [Trace events](tracing.html) -* [TTY](tty.html) -* [UDP/datagram](dgram.html) -* [URL](url.html) -* [Utilities](util.html) -* [V8](v8.html) -* [VM](vm.html) -* [WASI](wasi.html) -* [Worker threads](worker_threads.html) -* [Zlib](zlib.html) +* [Assertion testing](assert.md) +* [Async hooks](async_hooks.md) +* [Buffer](buffer.md) +* [C++ addons](addons.md) +* [C/C++ addons with N-API](n-api.md) +* [C++ embedder API](embedding.md) +* [Child processes](child_process.md) +* [Cluster](cluster.md) +* [Command-line options](cli.md) +* [Console](console.md) +* [Crypto](crypto.md) +* [Debugger](debugger.md) +* [Deprecated APIs](deprecations.md) +* [DNS](dns.md) +* [Domain](domain.md) +* [Errors](errors.md) +* [Events](events.md) +* [File system](fs.md) +* [Globals](globals.md) +* [HTTP](http.md) +* [HTTP/2](http2.md) +* [HTTPS](https.md) +* [Inspector](inspector.md) +* [Internationalization](intl.md) +* [Modules: CommonJS modules](modules.md) +* [Modules: ECMAScript modules](esm.md) +* [Modules: `module` API](module.md) +* [Modules: Packages](packages.md) +* [Net](net.md) +* [OS](os.md) +* [Path](path.md) +* [Performance hooks](perf_hooks.md) +* [Policies](policy.md) +* [Process](process.md) +* [Punycode](punycode.md) +* [Query strings](querystring.md) +* [QUIC](quic.md) +* [Readline](readline.md) +* [REPL](repl.md) +* [Report](report.md) +* [Stream](stream.md) +* [String decoder](string_decoder.md) +* [Timers](timers.md) +* [TLS/SSL](tls.md) +* [Trace events](tracing.md) +* [TTY](tty.md) +* [UDP/datagram](dgram.md) +* [URL](url.md) +* [Utilities](util.md) +* [V8](v8.md) +* [VM](vm.md) +* [WASI](wasi.md) +* [Worker threads](worker_threads.md) +* [Zlib](zlib.md)
diff --git a/doc/api/inspector.md b/doc/api/inspector.md index 7dc359a018..c22dbca03b 100644 --- a/doc/api/inspector.md +++ b/doc/api/inspector.md @@ -45,7 +45,7 @@ started. If wait is `true`, will block until a client has connected to the inspect port and flow control has been passed to the debugger client. -See the [security warning](cli.html#inspector_security) regarding the `host` +See the [security warning](cli.md#inspector_security) regarding the `host` parameter usage. ## `inspector.url()` diff --git a/doc/api/intl.md b/doc/api/intl.md index 8b7dee489b..434a06a5da 100644 --- a/doc/api/intl.md +++ b/doc/api/intl.md @@ -189,26 +189,26 @@ to be helpful: dedicated to ECMA-402. ["ICU Data"]: http://userguide.icu-project.org/icudata -[`--icu-data-dir`]: cli.html#cli_icu_data_dir_file +[`--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 [`Intl`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl -[`NODE_ICU_DATA`]: cli.html#cli_node_icu_data_file +[`NODE_ICU_DATA`]: cli.md#cli_node_icu_data_file [`Number.prototype.toLocaleString()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toLocaleString [`RegExp` Unicode Property Escapes]: https://github.com/tc39/proposal-regexp-unicode-property-escapes [`String.prototype.localeCompare()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare [`String.prototype.normalize()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize [`String.prototype.toLowerCase()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/toLowerCase [`String.prototype.toUpperCase()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/toUpperCase -[`require('buffer').transcode()`]: buffer.html#buffer_buffer_transcode_source_fromenc_toenc -[`require('util').TextDecoder`]: util.html#util_class_util_textdecoder +[`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.html#repl_repl +[REPL]: repl.md#repl_repl [Test262]: https://github.com/tc39/test262/tree/master/test/intl402 -[WHATWG URL parser]: url.html#url_the_whatwg_url_api +[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/module.md b/doc/api/module.md index 797c50b9d6..2fb6ca884b 100644 --- a/doc/api/module.md +++ b/doc/api/module.md @@ -200,14 +200,14 @@ consists of the following keys: * originalLine: {number} * originalColumn: {number} -[CommonJS]: modules.html -[ES Modules]: esm.html +[CommonJS]: modules.md +[ES Modules]: esm.md [Source map v3 format]: https://sourcemaps.info/spec.html#h.mofvlxcwqzej -[`--enable-source-maps`]: cli.html#cli_enable_source_maps +[`--enable-source-maps`]: cli.md#cli_enable_source_maps [`Error.prepareStackTrace(error, trace)`]: https://v8.dev/docs/stack-trace-api#customizing-stack-traces -[`NODE_V8_COVERAGE=dir`]: cli.html#cli_node_v8_coverage_dir +[`NODE_V8_COVERAGE=dir`]: cli.md#cli_node_v8_coverage_dir [`SourceMap`]: #module_class_module_sourcemap [`createRequire()`]: #module_module_createrequire_filename -[`module`]: modules.html#modules_the_module_object -[module wrapper]: modules_cjs.html#modules_cjs_the_module_wrapper +[`module`]: modules.md#modules_the_module_object +[module wrapper]: modules.md#modules_the_module_wrapper [source map include directives]: https://sourcemaps.info/spec.html#h.lmz475t4mvbx diff --git a/doc/api/modules.md b/doc/api/modules.md index d7efbb4075..171f9b978f 100644 --- a/doc/api/modules.md +++ b/doc/api/modules.md @@ -951,7 +951,7 @@ in order to be used. ## The `Module` object This section was moved to -[Modules: `module` core module](module.html#module_the_module_object). +[Modules: `module` core module](module.md#module_the_module_object). * `module.builtinModules` @@ -962,7 +962,7 @@ This section was moved to ## Source map v3 support This section was moved to -[Modules: `module` core module](module.html#module_source_map_v3_support). +[Modules: `module` core module](module.md#module_source_map_v3_support). * `module.findSourceMap(path[, error])` @@ -972,18 +972,18 @@ This section was moved to * `sourceMap.findEntry(lineNumber, columnNumber)` [GLOBAL_FOLDERS]: #modules_loading_from_the_global_folders -[`Error`]: errors.html#errors_class_error +[`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 -[`path.dirname()`]: path.html#path_path_dirname_path -[ECMAScript Modules]: esm.html -[an error]: errors.html#errors_err_require_esm +[`path.dirname()`]: path.md#path_path_dirname_path +[ECMAScript Modules]: esm.md +[an error]: errors.md#errors_err_require_esm [exports shortcut]: #modules_exports_shortcut [module resolution]: #modules_all_together -[native addons]: addons.html +[native addons]: addons.md [`require.main`]: #modules_require_main -[`package.json`]: packages.html#packages_node_js_package_json_field_definitions -[`"main"`]: packages.html#packages_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 afe05160e8..6afd8b7727 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -5889,7 +5889,7 @@ 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.html +[C++ Addons]: addons.md [CMake.js]: https://github.com/cmake-js/cmake-js [CMake]: https://cmake.org [ECMAScript Language Specification]: https://tc39.github.io/ecma262/ @@ -5934,9 +5934,9 @@ This API may only be called from the main thread. [Xcode]: https://developer.apple.com/xcode/ [`Number.MAX_SAFE_INTEGER`]: https://tc39.github.io/ecma262/#sec-number.max_safe_integer [`Number.MIN_SAFE_INTEGER`]: https://tc39.github.io/ecma262/#sec-number.min_safe_integer -[`Worker`]: worker_threads.html#worker_threads_class_worker -[`global`]: globals.html#globals_global -[`init` hooks]: async_hooks.html#async_hooks_init_asyncid_type_triggerasyncid_resource +[`Worker`]: worker_threads.md#worker_threads_class_worker +[`global`]: globals.md#globals_global +[`init` hooks]: async_hooks.md#async_hooks_init_asyncid_type_triggerasyncid_resource [`napi_add_async_cleanup_hook`]: #n_api_napi_add_async_cleanup_hook [`napi_add_env_cleanup_hook`]: #n_api_napi_add_env_cleanup_hook [`napi_add_finalizer`]: #n_api_napi_add_finalizer @@ -5992,14 +5992,14 @@ This API may only be called from the main thread. [`napi_wrap`]: #n_api_napi_wrap [`node-addon-api`]: https://github.com/nodejs/node-addon-api [`node_api.h`]: https://github.com/nodejs/node/blob/master/src/node_api.h -[`process.release`]: process.html#process_process_release +[`process.release`]: process.md#process_process_release [`uv_ref`]: https://docs.libuv.org/en/v1.x/handle.html#c.uv_ref [`uv_unref`]: https://docs.libuv.org/en/v1.x/handle.html#c.uv_unref -[async_hooks `type`]: async_hooks.html#async_hooks_type -[context-aware addons]: addons.html#addons_context_aware_addons +[async_hooks `type`]: async_hooks.md#async_hooks_type +[context-aware addons]: addons.md#addons_context_aware_addons [docs]: https://github.com/nodejs/node-addon-api#api-documentation -[global scope]: globals.html -[module scope]: modules.html#modules_the_module_scope +[global scope]: globals.md +[module scope]: modules.md#modules_the_module_scope [node-gyp]: https://github.com/nodejs/node-gyp [node-pre-gyp]: https://github.com/mapbox/node-pre-gyp [prebuild]: https://github.com/prebuild/prebuild diff --git a/doc/api/net.md b/doc/api/net.md index 4d7f031d2c..f581de0c8a 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.html#stream_class_stream_readable -[QUIC documentation]: quic.html +[Readable Stream]: stream.md#stream_class_stream_readable +[QUIC documentation]: quic.md [`'close'`]: #net_event_close [`'connect'`]: #net_event_connect [`'connection'`]: #net_event_connection @@ -1331,10 +1331,10 @@ Returns `true` if input is a version 6 IP address, otherwise returns `false`. [`'error'`]: #net_event_error_1 [`'listening'`]: #net_event_listening [`'timeout'`]: #net_event_timeout -[`EventEmitter`]: events.html#events_class_eventemitter -[`child_process.fork()`]: child_process.html#child_process_child_process_fork_modulepath_args_options -[`dns.lookup()` hints]: dns.html#dns_supported_getaddrinfo_flags -[`dns.lookup()`]: dns.html#dns_dns_lookup_hostname_options_callback +[`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 [`net.Server`]: #net_class_net_server [`net.Socket`]: #net_class_net_socket [`net.connect()`]: #net_net_connect @@ -1347,7 +1347,7 @@ Returns `true` if input is a version 6 IP address, otherwise returns `false`. [`net.createConnection(port, host)`]: #net_net_createconnection_port_host_connectlistener [`net.createServer()`]: #net_net_createserver_options_connectionlistener [`new net.Socket(options)`]: #net_new_net_socket_options -[`readable.setEncoding()`]: stream.html#stream_readable_setencoding_encoding +[`readable.setEncoding()`]: stream.md#stream_readable_setencoding_encoding [`server.close()`]: #net_server_close_callback [`server.listen()`]: #net_server_listen [`server.listen(handle)`]: #net_server_listen_handle_backlog_callback @@ -1366,11 +1366,11 @@ 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.html#stream_writable_writablelength -[`writable.destroyed`]: stream.html#stream_writable_destroyed -[`writable.destroy()`]: stream.html#stream_writable_destroy_error -[`writable.end()`]: stream.html#stream_writable_end_chunk_encoding_callback +[`writable.writableLength`]: stream.md#stream_writable_writablelength +[`writable.destroyed`]: stream.md#stream_writable_destroyed +[`writable.destroy()`]: stream.md#stream_writable_destroy_error +[`writable.end()`]: stream.md#stream_writable_end_chunk_encoding_callback [half-closed]: https://tools.ietf.org/html/rfc1122 -[stream_writable_write]: stream.html#stream_writable_write_chunk_encoding_callback +[stream_writable_write]: stream.md#stream_writable_write_chunk_encoding_callback [unspecified IPv4 address]: https://en.wikipedia.org/wiki/0.0.0.0 [unspecified IPv6 address]: https://en.wikipedia.org/wiki/IPv6_address#Unspecified_address diff --git a/doc/api/os.md b/doc/api/os.md index a4d241d1f7..50f64f7d8f 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -1269,9 +1269,9 @@ The following process scheduling constants are exported by -[`SystemError`]: errors.html#errors_class_systemerror -[`process.arch`]: process.html#process_process_arch -[`process.platform`]: process.html#process_process_platform +[`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 77183fb23e..5dccc5e398 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -903,7 +903,7 @@ added: v0.4.0 ``` The `"main"` field defines the script that is used when the [package directory -is loaded via `require()`](modules.html#modules_folders_as_modules). Its value +is loaded via `require()`](modules.md#modules_folders_as_modules). Its value is interpreted as a path. ```js @@ -959,10 +959,10 @@ analogous to the exports field. [Babel]: https://babeljs.io/ [Conditional exports]: #packages_conditional_exports -[CommonJS]: modules.html -[`ERR_PACKAGE_PATH_NOT_EXPORTED`]: errors.html#errors_err_package_path_not_exported -[ES modules]: esm.html -[ES module]: esm.html +[CommonJS]: modules.md +[`ERR_PACKAGE_PATH_NOT_EXPORTED`]: errors.md#errors_err_package_path_not_exported +[ES modules]: esm.md +[ES module]: esm.md [`esm`]: https://github.com/standard-things/esm#readme [`"exports"`]: #packages_exports [`"main"`]: #packages_main @@ -973,5 +973,5 @@ analogous to the exports field. [`package.json`]: #packages_node_js_package_json_field_definitions [self-reference]: #packages_self_referencing_a_package_using_its_name [subpath exports]: #packages_subpath_exports -[the full specifier path]: modules_esm.html#modules_esm_mandatory_file_extensions +[the full specifier path]: esm.md#esm_mandatory_file_extensions [the dual CommonJS/ES module packages section]: #packages_dual_commonjs_es_module_packages diff --git a/doc/api/path.md b/doc/api/path.md index e78850fb7d..1193d4ca36 100644 --- a/doc/api/path.md +++ b/doc/api/path.md @@ -575,7 +575,7 @@ added: v0.11.15 The `path.win32` property provides access to Windows-specific implementations of the `path` methods. -[`TypeError`]: errors.html#errors_class_typeerror +[`TypeError`]: errors.md#errors_class_typeerror [`path.parse()`]: #path_path_parse_path [`path.posix`]: #path_path_posix [`path.sep`]: #path_path_sep diff --git a/doc/api/perf_hooks.md b/doc/api/perf_hooks.md index f260e28c23..aca7549b24 100644 --- a/doc/api/perf_hooks.md +++ b/doc/api/perf_hooks.md @@ -756,12 +756,12 @@ obs.observe({ entryTypes: ['function'], buffered: true }); require('some-module'); ``` -[`'exit'`]: process.html#process_event_exit -[`process.hrtime()`]: process.html#process_process_hrtime_time -[`child_process.spawnSync()`]: child_process.html#child_process_child_process_spawnsync_command_args_options +[`'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.html +[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/ diff --git a/doc/api/process.md b/doc/api/process.md index 45c15a6771..8ef90a58dc 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -2607,23 +2607,23 @@ cases: code will be `128` + `6`, or `134`. [`'exit'`]: #process_event_exit -[`'message'`]: child_process.html#child_process_event_message +[`'message'`]: child_process.md#child_process_event_message [`'uncaughtException'`]: #process_event_uncaughtexception -[`--unhandled-rejections`]: cli.html#cli_unhandled_rejections_mode -[`Buffer`]: buffer.html -[`ChildProcess.disconnect()`]: child_process.html#child_process_subprocess_disconnect -[`ChildProcess.send()`]: child_process.html#child_process_subprocess_send_message_sendhandle_options_callback -[`ChildProcess`]: child_process.html#child_process_class_childprocess -[`Error`]: errors.html#errors_class_error -[`EventEmitter`]: events.html#events_class_eventemitter -[`NODE_OPTIONS`]: cli.html#cli_node_options_options -[`Worker`]: worker_threads.html#worker_threads_class_worker -[`console.error()`]: console.html#console_console_error_data_args -[`console.log()`]: console.html#console_console_log_data_args -[`domain`]: domain.html -[`net.Server`]: net.html#net_class_net_server -[`net.Socket`]: net.html#net_class_net_socket -[`os.constants.dlopen`]: os.html#os_dlopen_constants +[`--unhandled-rejections`]: cli.md#cli_unhandled_rejections_mode +[`Buffer`]: buffer.md +[`ChildProcess.disconnect()`]: child_process.md#child_process_subprocess_disconnect +[`ChildProcess.send()`]: child_process.md#child_process_subprocess_send_message_sendhandle_options_callback +[`ChildProcess`]: child_process.md#child_process_class_childprocess +[`Error`]: errors.md#errors_class_error +[`EventEmitter`]: events.md#events_class_eventemitter +[`NODE_OPTIONS`]: cli.md#cli_node_options_options +[`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 +[`domain`]: domain.md +[`net.Server`]: net.md#net_class_net_server +[`net.Socket`]: net.md#net_class_net_socket +[`os.constants.dlopen`]: os.md#os_dlopen_constants [`process.argv`]: #process_process_argv [`process.config`]: #process_process_config [`process.execPath`]: #process_process_execpath @@ -2632,34 +2632,34 @@ cases: [`process.hrtime()`]: #process_process_hrtime_time [`process.hrtime.bigint()`]: #process_process_hrtime_bigint [`process.kill()`]: #process_process_kill_pid_signal -[`process.setUncaughtExceptionCaptureCallback()`]: process.html#process_process_setuncaughtexceptioncapturecallback_fn +[`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 -[`require()`]: globals.html#globals_require -[`require.main`]: modules.html#modules_accessing_the_main_module -[`require.resolve()`]: modules.html#modules_require_resolve_request_options -[`subprocess.kill()`]: child_process.html#child_process_subprocess_kill_signal -[`v8.setFlagsFromString()`]: v8.html#v8_v8_setflagsfromstring_flags -[Advanced serialization for `child_process`]: child_process.html#child_process_advanced_serialization +[`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.html -[Cluster]: cluster.html -[Duplex]: stream.html#stream_duplex_and_transform_streams +[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.html#stream_readable_streams -[`readable.read()`]: stream.html#stream_readable_read_size +[Readable]: stream.md#stream_readable_streams +[`readable.read()`]: stream.md#stream_readable_read_size [Signal Events]: #process_signal_events -[Stream compatibility]: stream.html#stream_compatibility_with_older_node_js_versions -[TTY]: tty.html#tty_tty -[Writable]: stream.html#stream_writable_streams -[debugger]: debugger.html -[note on process I/O]: process.html#process_a_note_on_process_i_o +[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 [process_emit_warning]: #process_process_emitwarning_warning_type_code_ctor [process_warning]: #process_event_warning -[report documentation]: report.html -[terminal raw mode]: tty.html#tty_readstream_setrawmode_mode +[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 diff --git a/doc/api/quic.md b/doc/api/quic.md index 1839f1ebf1..bdd221df69 100644 --- a/doc/api/quic.md +++ b/doc/api/quic.md @@ -2499,20 +2499,20 @@ server.listen({ }); ``` -[`crypto.getCurves()`]: crypto.html#crypto_crypto_getcurves +[`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.html#tls_tls_getciphers +[`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.html#tls_modifying_the_default_tls_cipher_suite +[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.html#crypto_openssl_options +[OpenSSL Options]: crypto.md#crypto_openssl_options [Perfect Forward Secrecy]: #tls_perfect_forward_secrecy -[promisified version of `lookup()`]: dns.html#dns_dnspromises_lookup_hostname_options +[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 8d3eef1ab4..f44c9101b8 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -865,15 +865,15 @@ const { createInterface } = require('readline'); -[`'SIGCONT'`]: readline.html#readline_event_sigcont -[`'SIGTSTP'`]: readline.html#readline_event_sigtstp +[`'SIGCONT'`]: readline.md#readline_event_sigcont +[`'SIGTSTP'`]: readline.md#readline_event_sigtstp [`'line'`]: #readline_event_line -[`fs.ReadStream`]: fs.html#fs_class_fs_readstream -[`process.stdin`]: process.html#process_process_stdin -[`process.stdout`]: process.html#process_process_stdout +[`fs.ReadStream`]: fs.md#fs_class_fs_readstream +[`process.stdin`]: process.md#process_process_stdin +[`process.stdout`]: process.md#process_process_stdout [`rl.close()`]: #readline_rl_close -[Readable]: stream.html#stream_readable_streams -[TTY]: tty.html +[Readable]: stream.md#stream_readable_streams +[TTY]: tty.md [TTY keybindings]: #readline_tty_keybindings -[Writable]: stream.html#stream_writable_streams +[Writable]: stream.md#stream_writable_streams [reading files]: #readline_example_read_file_stream_line_by_line diff --git a/doc/api/repl.md b/doc/api/repl.md index 7c16a9c266..57746a0c7a 100644 --- a/doc/api/repl.md +++ b/doc/api/repl.md @@ -748,18 +748,18 @@ a `net.Server` and `net.Socket` instance, see: For an example of running a REPL instance over [`curl(1)`][], see: . -[TTY keybindings]: readline.html#readline_tty_keybindings +[TTY keybindings]: readline.md#readline_tty_keybindings [ZSH]: https://en.wikipedia.org/wiki/Z_shell -[`'uncaughtException'`]: process.html#process_event_uncaughtexception -[`--experimental-repl-await`]: cli.html#cli_experimental_repl_await -[`ERR_DOMAIN_CANNOT_SET_UNCAUGHT_EXCEPTION_CAPTURE`]: errors.html#errors_err_domain_cannot_set_uncaught_exception_capture -[`ERR_INVALID_REPL_INPUT`]: errors.html#errors_err_invalid_repl_input +[`'uncaughtException'`]: process.md#process_event_uncaughtexception +[`--experimental-repl-await`]: cli.md#cli_experimental_repl_await +[`ERR_DOMAIN_CANNOT_SET_UNCAUGHT_EXCEPTION_CAPTURE`]: errors.md#errors_err_domain_cannot_set_uncaught_exception_capture +[`ERR_INVALID_REPL_INPUT`]: errors.md#errors_err_invalid_repl_input [`curl(1)`]: https://curl.haxx.se/docs/manpage.html -[`domain`]: domain.html -[`process.setUncaughtExceptionCaptureCallback()`]: process.html#process_process_setuncaughtexceptioncapturecallback_fn -[`readline.InterfaceCompleter`]: readline.html#readline_use_of_the_completer_function +[`domain`]: domain.md +[`process.setUncaughtExceptionCaptureCallback()`]: process.md#process_process_setuncaughtexceptioncapturecallback_fn +[`readline.InterfaceCompleter`]: readline.md#readline_use_of_the_completer_function [`repl.ReplServer`]: #repl_class_replserver [`repl.start()`]: #repl_repl_start_options [`reverse-i-search`]: #repl_reverse_i_search -[`util.inspect()`]: util.html#util_util_inspect_object_options -[stream]: stream.html +[`util.inspect()`]: util.md#util_util_inspect_object_options +[stream]: stream.md diff --git a/doc/api/report.md b/doc/api/report.md index 95d53697f0..cffa288d9f 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.html -[`Worker`]: worker_threads.html +[`process API documentation`]: process.md +[`Worker`]: worker_threads.md diff --git a/doc/api/stream.md b/doc/api/stream.md index 49d05be403..b10e041615 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -3086,17 +3086,17 @@ contain multi-byte characters. [`'finish'`]: #stream_event_finish [`'readable'`]: #stream_event_readable [`Duplex`]: #stream_class_stream_duplex -[`EventEmitter`]: events.html#events_class_eventemitter +[`EventEmitter`]: events.md#events_class_eventemitter [`Readable`]: #stream_class_stream_readable [`Symbol.hasInstance`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/hasInstance [`Transform`]: #stream_class_stream_transform [`Writable`]: #stream_class_stream_writable -[`fs.createReadStream()`]: fs.html#fs_fs_createreadstream_path_options -[`fs.createWriteStream()`]: fs.html#fs_fs_createwritestream_path_options -[`net.Socket`]: net.html#net_class_net_socket -[`process.stderr`]: process.html#process_process_stderr -[`process.stdin`]: process.html#process_process_stdin -[`process.stdout`]: process.html#process_process_stdout +[`fs.createReadStream()`]: fs.md#fs_fs_createreadstream_path_options +[`fs.createWriteStream()`]: fs.md#fs_fs_createwritestream_path_options +[`net.Socket`]: net.md#net_class_net_socket +[`process.stderr`]: process.md#process_process_stderr +[`process.stdin`]: process.md#process_process_stdin +[`process.stdout`]: process.md#process_process_stdout [`readable._read()`]: #stream_readable_read_size_1 [`readable.push('')`]: #stream_readable_push [`readable.setEncoding()`]: #stream_readable_setencoding_encoding @@ -3115,19 +3115,19 @@ contain multi-byte characters. [`writable.end()`]: #stream_writable_end_chunk_encoding_callback [`writable.uncork()`]: #stream_writable_uncork [`writable.writableFinished`]: #stream_writable_writablefinished -[`zlib.createDeflate()`]: zlib.html#zlib_zlib_createdeflate_options +[`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.html#http_class_http_clientrequest -[HTTP responses, on the server]: http.html#http_class_http_serverresponse -[TCP sockets]: net.html#net_class_net_socket -[child process stdin]: child_process.html#child_process_subprocess_stdin -[child process stdout and stderr]: child_process.html#child_process_subprocess_stdout -[crypto]: crypto.html -[fs read streams]: fs.html#fs_class_fs_readstream -[fs write streams]: fs.html#fs_class_fs_writestream -[http-incoming-message]: http.html#http_class_http_incomingmessage +[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 +[fs read streams]: fs.md#fs_class_fs_readstream +[fs write streams]: fs.md#fs_class_fs_writestream +[http-incoming-message]: http.md#http_class_http_incomingmessage [hwm-gotcha]: #stream_highwatermark_discrepancy_after_calling_readable_setencoding [object-mode]: #stream_object_mode [readable-_construct]: #stream_readable_construct_callback @@ -3151,4 +3151,4 @@ contain multi-byte characters. [writable-_destroy]: #stream_writable_destroy_err_callback [writable-destroy]: #stream_writable_destroy_error [writable-new]: #stream_new_stream_writable_options -[zlib]: zlib.html +[zlib]: zlib.md diff --git a/doc/api/string_decoder.md b/doc/api/string_decoder.md index 59056b8613..a810462f50 100644 --- a/doc/api/string_decoder.md +++ b/doc/api/string_decoder.md @@ -91,4 +91,4 @@ Returns a decoded string, ensuring that any incomplete multibyte characters at returned string and stored in an internal buffer for the next call to `stringDecoder.write()` or `stringDecoder.end()`. -[encoding]: buffer.html#buffer_buffers_and_character_encodings +[encoding]: buffer.md#buffer_buffers_and_character_encodings diff --git a/doc/api/synopsis.md b/doc/api/synopsis.md index d4b0ffa36c..cb43312f35 100644 --- a/doc/api/synopsis.md +++ b/doc/api/synopsis.md @@ -86,6 +86,6 @@ Now, open any preferred web browser and visit `http://127.0.0.1:3000`. If the browser displays the string `Hello, World!`, that indicates the server is working. -[Command-line options]: cli.html#cli_command_line_options +[Command-line options]: cli.md#cli_command_line_options [Installing Node.js via package manager]: https://nodejs.org/en/download/package-manager/ -[web server]: http.html +[web server]: http.md diff --git a/doc/api/timers.md b/doc/api/timers.md index 71206324dc..19b8499136 100644 --- a/doc/api/timers.md +++ b/doc/api/timers.md @@ -353,13 +353,13 @@ const timersPromises = require('timers/promises'); cancel the scheduled `Immediate`. [Event Loop]: https://nodejs.org/en/docs/guides/event-loop-timers-and-nexttick/#setimmediate-vs-settimeout -[`AbortController`]: globals.html#globals_class_abortcontroller -[`TypeError`]: errors.html#errors_class_typeerror -[`clearImmediate()`]: timers.html#timers_clearimmediate_immediate -[`clearInterval()`]: timers.html#timers_clearinterval_timeout -[`clearTimeout()`]: timers.html#timers_cleartimeout_timeout -[`setImmediate()`]: timers.html#timers_setimmediate_callback_args -[`setInterval()`]: timers.html#timers_setinterval_callback_delay_args -[`setTimeout()`]: timers.html#timers_settimeout_callback_delay_args -[`util.promisify()`]: util.html#util_util_promisify_original -[`worker_threads`]: worker_threads.html +[`AbortController`]: globals.md#globals_class_abortcontroller +[`TypeError`]: errors.md#errors_class_typeerror +[`clearImmediate()`]: timers.md#timers_clearimmediate_immediate +[`clearInterval()`]: timers.md#timers_clearinterval_timeout +[`clearTimeout()`]: timers.md#timers_cleartimeout_timeout +[`setImmediate()`]: timers.md#timers_setimmediate_callback_args +[`setInterval()`]: timers.md#timers_setinterval_callback_delay_args +[`setTimeout()`]: timers.md#timers_settimeout_callback_delay_args +[`util.promisify()`]: util.md#util_util_promisify_original +[`worker_threads`]: worker_threads.md diff --git a/doc/api/tls.md b/doc/api/tls.md index ebeae68bb6..679ba46220 100644 --- a/doc/api/tls.md +++ b/doc/api/tls.md @@ -1981,21 +1981,21 @@ added: v11.4.0 [`'secureConnect'`]: #tls_event_secureconnect [`'secureConnection'`]: #tls_event_secureconnection [`'session'`]: #tls_event_session -[`--tls-cipher-list`]: cli.html#cli_tls_cipher_list_list -[`NODE_OPTIONS`]: cli.html#cli_node_options_options +[`--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.html#crypto_crypto_getcurves -[`Duplex`]: stream.html#stream_class_stream_duplex -[`net.createServer()`]: net.html#net_net_createserver_options_connectionlistener -[`net.Server.address()`]: net.html#net_server_address -[`net.Server`]: net.html#net_class_net_server -[`net.Socket`]: net.html#net_class_net_socket +[`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 [`server.addContext()`]: #tls_server_addcontext_hostname_context [`server.getTicketKeys()`]: #tls_server_getticketkeys -[`server.listen()`]: net.html#net_server_listen +[`server.listen()`]: net.md#net_server_listen [`server.setTicketKeys()`]: #tls_server_setticketkeys_keys -[`socket.connect()`]: net.html#net_socket_connect_options_connectlistener +[`socket.connect()`]: net.md#net_socket_connect_options_connectlistener [`tls.DEFAULT_ECDH_CURVE`]: #tls_tls_default_ecdh_curve [`tls.DEFAULT_MAX_VERSION`]: #tls_tls_default_max_version [`tls.DEFAULT_MIN_VERSION`]: #tls_tls_default_min_version @@ -2017,14 +2017,14 @@ added: v11.4.0 [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.html#crypto_openssl_options +[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.html#stream_stream +[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 diff --git a/doc/api/tracing.md b/doc/api/tracing.md index 9350e0b9ca..9d1c873a3e 100644 --- a/doc/api/tracing.md +++ b/doc/api/tracing.md @@ -207,7 +207,7 @@ t2.enable(); console.log(trace_events.getEnabledCategories()); ``` -[Performance API]: perf_hooks.html -[V8]: v8.html -[`Worker`]: worker_threads.html#worker_threads_class_worker -[`async_hooks`]: async_hooks.html +[Performance API]: perf_hooks.md +[V8]: v8.md +[`Worker`]: worker_threads.md#worker_threads_class_worker +[`async_hooks`]: async_hooks.md diff --git a/doc/api/tty.md b/doc/api/tty.md index f4a83c290a..a757b5b370 100644 --- a/doc/api/tty.md +++ b/doc/api/tty.md @@ -211,10 +211,10 @@ added: v0.7.7 * Returns: {number[]} -`writeStream.getWindowSize()` returns the size of the [TTY](tty.html) +`writeStream.getWindowSize()` returns the size of the [TTY](tty.md) corresponding to this `WriteStream`. The array is of the type `[numColumns, numRows]` where `numColumns` and `numRows` represent the number -of columns and rows in the corresponding [TTY](tty.html). +of columns and rows in the corresponding [TTY](tty.md). ### `writeStream.hasColors([count][, env])` /gms, ''); +const gtocMD = fs.readFileSync(gtocPath, 'utf8') + .replace(/\(([^#?]+?)\.md\)/ig, (_, filename) => `(${filename}.html)`) + .replace(/^/gms, ''); const gtocHTML = unified() .use(markdown) .use(remark2rehype, { allowDangerousHtml: true }) diff --git a/tools/doc/markdown.js b/tools/doc/markdown.js index 97feadbf99..a3b2f0a94e 100644 --- a/tools/doc/markdown.js +++ b/tools/doc/markdown.js @@ -2,14 +2,25 @@ const visit = require('unist-util-visit'); +const referenceToLocalMdFile = /^(?![+a-z]+:)([^#?]+)\.md(#.+)?$/i; + module.exports = { - replaceLinks + replaceLinks, + referenceToLocalMdFile, }; function replaceLinks({ filename, linksMapper }) { return (tree) => { const fileHtmlUrls = linksMapper[filename]; + visit(tree, (node) => { + if (node.url) { + node.url = node.url.replace( + referenceToLocalMdFile, + (_, filename, hash) => `${filename}.html${hash || ''}` + ); + } + }); visit(tree, 'definition', (node) => { const htmlUrl = fileHtmlUrls && fileHtmlUrls[node.identifier];