Skip to content

Commit 2388852

Browse files
TrottBethGriggs
authored andcommittedDec 15, 2020
doc: clarify experimental API elements in vm.md
Remove redundant "should not be considered stable" (it immediately follows a clause saying that it is "experimental") and replace with a more clear (to me, at least) statement that we don't recommend using the feature in production. PR-URL: #35594 Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent 806a269 commit 2388852

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed
 

‎doc/api/vm.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,8 @@ changes:
8787
* `importModuleDynamically` {Function} Called during evaluation of this module
8888
when `import()` is called. If this option is not specified, calls to
8989
`import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][].
90-
This option is part of the experimental modules API, and should not be
91-
considered stable.
90+
This option is part of the experimental modules API. We do not recommend
91+
using it in a production environment.
9292
* `specifier` {string} specifier passed to `import()`
9393
* `script` {vm.Script}
9494
* Returns: {Module Namespace Object|vm.Module} Returning a `vm.Module` is
@@ -979,8 +979,8 @@ changes:
979979
* `importModuleDynamically` {Function} Called during evaluation of this module
980980
when `import()` is called. If this option is not specified, calls to
981981
`import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][].
982-
This option is part of the experimental modules API, and should not be
983-
considered stable.
982+
This option is part of the experimental modules API. We do not recommend
983+
using it in a production environment.
984984
* `specifier` {string} specifier passed to `import()`
985985
* `script` {vm.Script}
986986
* Returns: {Module Namespace Object|vm.Module} Returning a `vm.Module` is
@@ -1077,8 +1077,8 @@ changes:
10771077
* `importModuleDynamically` {Function} Called during evaluation of this module
10781078
when `import()` is called. If this option is not specified, calls to
10791079
`import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][].
1080-
This option is part of the experimental modules API, and should not be
1081-
considered stable.
1080+
This option is part of the experimental modules API. We do not recommend
1081+
using it in a production environment.
10821082
* `specifier` {string} specifier passed to `import()`
10831083
* `script` {vm.Script}
10841084
* Returns: {Module Namespace Object|vm.Module} Returning a `vm.Module` is
@@ -1156,8 +1156,8 @@ changes:
11561156
* `importModuleDynamically` {Function} Called during evaluation of this module
11571157
when `import()` is called. If this option is not specified, calls to
11581158
`import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][].
1159-
This option is part of the experimental modules API, and should not be
1160-
considered stable.
1159+
This option is part of the experimental modules API. We do not recommend
1160+
using it in a production environment.
11611161
* `specifier` {string} specifier passed to `import()`
11621162
* `script` {vm.Script}
11631163
* Returns: {Module Namespace Object|vm.Module} Returning a `vm.Module` is

0 commit comments

Comments
 (0)
Please sign in to comment.