Commit a46368a
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.
PR-URL: #60960
Refs: #56241
Reviewed-By: Geoffrey Booth <webadmin@geoffreybooth.com>1 parent d8f1dea commit a46368a
2 files changed
Lines changed: 505 additions & 335 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1184,9 +1184,9 @@ changes: | |||
| 1184 | 1184 | ||
| 1185 | 1185 | > This flag is discouraged and may be removed in a future version of Node.js. | |
| 1186 | 1186 | > Please use | |
| 1187 | - > [`--import` with `register()`][module customization hooks: enabling] instead. | ||
| 1187 | + > [`--import` with `register()`][preloading asynchronous module customization hooks] instead. | ||
| 1188 | 1188 | ||
| 1189 | - Specify the `module` containing exported [module customization hooks][]. | ||
| 1189 | + Specify the `module` containing exported [asynchronous module customization hooks][]. | ||
| 1190 | 1190 | `module` may be any string accepted as an [`import` specifier][]. | |
| 1191 | 1191 | ||
| 1192 | 1192 | This feature requires `--allow-worker` if used with the [Permission Model][]. | |
@@ -4146,8 +4146,6 @@ node --stack-trace-limit=12 -p -e "Error.stackTraceLimit" # prints 12 | |||
| 4146 | 4146 | [ExperimentalWarning: `vm.measureMemory` is an experimental feature]: vm.md#vmmeasurememoryoptions | |
| 4147 | 4147 | [File System Permissions]: permissions.md#file-system-permissions | |
| 4148 | 4148 | [Loading ECMAScript modules using `require()`]: modules.md#loading-ecmascript-modules-using-require | |
| 4149 | - [Module customization hooks]: module.md#customization-hooks | ||
| 4150 | - [Module customization hooks: enabling]: module.md#enabling | ||
| 4151 | 4149 | [Module resolution and loading]: packages.md#module-resolution-and-loading | |
| 4152 | 4150 | [Navigator API]: globals.md#navigator | |
| 4153 | 4151 | [Node.js issue tracker]: https://github.com/nodejs/node/issues | |
@@ -4210,6 +4208,7 @@ node --stack-trace-limit=12 -p -e "Error.stackTraceLimit" # prints 12 | |||
| 4210 | 4208 | [`v8.startupSnapshot.addDeserializeCallback()`]: v8.md#v8startupsnapshotadddeserializecallbackcallback-data | |
| 4211 | 4209 | [`v8.startupSnapshot.setDeserializeMainFunction()`]: v8.md#v8startupsnapshotsetdeserializemainfunctioncallback-data | |
| 4212 | 4210 | [`v8.startupSnapshot` API]: v8.md#startup-snapshot-api | |
| 4211 | + [asynchronous module customization hooks]: module.md#asynchronous-customization-hooks | ||
| 4213 | 4212 | [captured by the built-in snapshot of Node.js]: https://github.com/nodejs/node/blob/b19525a33cc84033af4addd0f80acd4dc33ce0cf/test/parallel/test-bootstrap-modules.js#L24 | |
| 4214 | 4213 | [collecting code coverage from tests]: test.md#collecting-code-coverage | |
| 4215 | 4214 | [conditional exports]: packages.md#conditional-exports | |
@@ -4224,6 +4223,7 @@ node --stack-trace-limit=12 -p -e "Error.stackTraceLimit" # prints 12 | |||
| 4224 | 4223 | [jitless]: https://v8.dev/blog/jitless | |
| 4225 | 4224 | [libuv threadpool documentation]: https://docs.libuv.org/en/latest/threadpool.html | |
| 4226 | 4225 | [module compile cache]: module.md#module-compile-cache | |
| 4226 | + [preloading asynchronous module customization hooks]: module.md#registration-of-asynchronous-customization-hooks | ||
| 4227 | 4227 | [remote code execution]: https://www.owasp.org/index.php/Code_Injection | |
| 4228 | 4228 | [running tests from the command line]: test.md#running-tests-from-the-command-line | |
| 4229 | 4229 | [scavenge garbage collector]: https://v8.dev/blog/orinoco-parallel-scavenger | |
0 commit comments