Skip to content

doc: clarify experimental API elements in vm.md #35594

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Trott merged 1 commit into from
Oct 19, 2020
+8 −8
Merged

doc: clarify experimental API elements in vm.md #35594

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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>
  • Loading branch information
@Trott
Trott committed Oct 19, 2020
commit ce03a182cf4c5fb433edce2ef7dd9f21c26e76bb
16 changes: 8 additions & 8 deletions doc/api/vm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@ changes:
* `importModuleDynamically` {Function} Called during evaluation of this module
when `import()` is called. If this option is not specified, calls to
`import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][].
This option is part of the experimental modules API, and should not be
considered stable.
This option is part of the experimental modules API. We do not recommend
using it in a production environment.
* `specifier` {string} specifier passed to `import()`
* `script` {vm.Script}
* Returns: {Module Namespace Object|vm.Module} Returning a `vm.Module` is
Expand Down Expand Up @@ -981,8 +981,8 @@ changes:
* `importModuleDynamically` {Function} Called during evaluation of this module
when `import()` is called. If this option is not specified, calls to
`import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][].
This option is part of the experimental modules API, and should not be
considered stable.
This option is part of the experimental modules API. We do not recommend
using it in a production environment.
* `specifier` {string} specifier passed to `import()`
* `script` {vm.Script}
* Returns: {Module Namespace Object|vm.Module} Returning a `vm.Module` is
Expand Down Expand Up @@ -1079,8 +1079,8 @@ changes:
* `importModuleDynamically` {Function} Called during evaluation of this module
when `import()` is called. If this option is not specified, calls to
`import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][].
This option is part of the experimental modules API, and should not be
considered stable.
This option is part of the experimental modules API. We do not recommend
using it in a production environment.
* `specifier` {string} specifier passed to `import()`
* `script` {vm.Script}
* Returns: {Module Namespace Object|vm.Module} Returning a `vm.Module` is
Expand Down Expand Up @@ -1158,8 +1158,8 @@ changes:
* `importModuleDynamically` {Function} Called during evaluation of this module
when `import()` is called. If this option is not specified, calls to
`import()` will reject with [`ERR_VM_DYNAMIC_IMPORT_CALLBACK_MISSING`][].
This option is part of the experimental modules API, and should not be
considered stable.
This option is part of the experimental modules API. We do not recommend
using it in a production environment.
* `specifier` {string} specifier passed to `import()`
* `script` {vm.Script}
* Returns: {Module Namespace Object|vm.Module} Returning a `vm.Module` is
Expand Down