Commit 0d3ec1a
doc: fix misaligned options in vm.compileFunction()
Current alignment mislead doc reader into thinking
`importModuleDynamically` is a separate positional param right next to
`options`, which is incorrect and need to be fixed.
This misalignment is introduced in a PR merged in Feb 2024.
I belive this doc fix applies to node v20 and above.
Refs: #51244
PR-URL: #58145
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Daeyeon Jeong <daeyeon.dev@gmail.com>1 parent 1f70baf commit 0d3ec1a
1 file changed
Lines changed: 7 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1042,13 +1042,13 @@ changes: | |||
| 1042 | 1042 | * `contextExtensions` {Object\[]} An array containing a collection of context | |
| 1043 | 1043 | extensions (objects wrapping the current scope) to be applied while | |
| 1044 | 1044 | compiling. **Default:** `[]`. | |
| 1045 | - * `importModuleDynamically` | ||
| 1046 | - {Function|vm.constants.USE\_MAIN\_CONTEXT\_DEFAULT\_LOADER} | ||
| 1047 | - Used to specify the how the modules should be loaded during the evaluation of | ||
| 1048 | - this function when `import()` is called. This option is part of the | ||
| 1049 | - experimental modules API. We do not recommend using it in a production | ||
| 1050 | - environment. For detailed information, see | ||
| 1051 | - [Support of dynamic `import()` in compilation APIs][]. | ||
| 1045 | + * `importModuleDynamically` | ||
| 1046 | + {Function|vm.constants.USE\_MAIN\_CONTEXT\_DEFAULT\_LOADER} | ||
| 1047 | + Used to specify the how the modules should be loaded during the evaluation of | ||
| 1048 | + this function when `import()` is called. This option is part of the | ||
| 1049 | + experimental modules API. We do not recommend using it in a production | ||
| 1050 | + environment. For detailed information, see | ||
| 1051 | + [Support of dynamic `import()` in compilation APIs][]. | ||
| 1052 | 1052 | * Returns: {Function} | |
| 1053 | 1053 | ||
| 1054 | 1054 | Compiles the given code into the provided context (if no context is | |
0 commit comments