Skip to content

Commit 9ae6492

Browse files
committed
doc: reorganize docs of module customization hooks
This reorganizes the documentation of module customization hooks to promote the synchronous variant as it has fewer caveats. Previously the documentation was organized as follows: To do something: 1. For asynchronous hooks, do this, which may have these caveats 2. For synchronous hooks, do this, which does not have the caveats To do something else: 1. For asynchronous hooks, do this, which may have these caveats 2. For synchronous hooks, do this, which does not have the caveats It's now organized as follows: Synchronous hooks: To do something, do this. To do something else, do this. (No mention that it doesn't have caveats, because users are not supposed to burden themselves with caveats in the other API that they do not use). Asynchronous hooks: They have these caveats, if they are too complex to deal with, consider use the synchronous variant. To do something, do this, which may have these caveats. To do something, do this, which may have these caveats.
1 parent 1fbe842 commit 9ae6492

File tree

2 files changed

+505
-335
lines changed

2 files changed

+505
-335
lines changed

doc/api/cli.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1188,9 +1188,9 @@ changes:
11881188

11891189
> This flag is discouraged and may be removed in a future version of Node.js.
11901190
> Please use
1191-
> [`--import` with `register()`][module customization hooks: enabling] instead.
1191+
> [`--import` with `register()`][preloading asynchronous module customization hooks] instead.
11921192
1193-
Specify the `module` containing exported [module customization hooks][].
1193+
Specify the `module` containing exported [asynchronous module customization hooks][].
11941194
`module` may be any string accepted as an [`import` specifier][].
11951195

11961196
This feature requires `--allow-worker` if used with the [Permission Model][].
@@ -4141,8 +4141,6 @@ node --stack-trace-limit=12 -p -e "Error.stackTraceLimit" # prints 12
41414141
[ExperimentalWarning: `vm.measureMemory` is an experimental feature]: vm.md#vmmeasurememoryoptions
41424142
[File System Permissions]: permissions.md#file-system-permissions
41434143
[Loading ECMAScript modules using `require()`]: modules.md#loading-ecmascript-modules-using-require
4144-
[Module customization hooks]: module.md#customization-hooks
4145-
[Module customization hooks: enabling]: module.md#enabling
41464144
[Module resolution and loading]: packages.md#module-resolution-and-loading
41474145
[Navigator API]: globals.md#navigator
41484146
[Node.js issue tracker]: https://github.com/nodejs/node/issues
@@ -4204,6 +4202,7 @@ node --stack-trace-limit=12 -p -e "Error.stackTraceLimit" # prints 12
42044202
[`v8.startupSnapshot.addDeserializeCallback()`]: v8.md#v8startupsnapshotadddeserializecallbackcallback-data
42054203
[`v8.startupSnapshot.setDeserializeMainFunction()`]: v8.md#v8startupsnapshotsetdeserializemainfunctioncallback-data
42064204
[`v8.startupSnapshot` API]: v8.md#startup-snapshot-api
4205+
[asynchronous module customization hooks]: module.md#asynchronous-customization-hooks
42074206
[captured by the built-in snapshot of Node.js]: https://github.com/nodejs/node/blob/b19525a33cc84033af4addd0f80acd4dc33ce0cf/test/parallel/test-bootstrap-modules.js#L24
42084207
[collecting code coverage from tests]: test.md#collecting-code-coverage
42094208
[conditional exports]: packages.md#conditional-exports
@@ -4218,6 +4217,7 @@ node --stack-trace-limit=12 -p -e "Error.stackTraceLimit" # prints 12
42184217
[jitless]: https://v8.dev/blog/jitless
42194218
[libuv threadpool documentation]: https://docs.libuv.org/en/latest/threadpool.html
42204219
[module compile cache]: module.md#module-compile-cache
4220+
[preloading asynchronous module customization hooks]: module.md#registration-of-asynchronous-customization-hooks
42214221
[remote code execution]: https://www.owasp.org/index.php/Code_Injection
42224222
[running tests from the command line]: test.md#running-tests-from-the-command-line
42234223
[scavenge garbage collector]: https://v8.dev/blog/orinoco-parallel-scavenger

0 commit comments

Comments
 (0)