summaryrefslogtreecommitdiff
path: root/doc/api/vm.md
diff options
context:
space:
mode:
authorNick Schonning <nschonni@gmail.com>2019-09-13 00:22:29 -0400
committerRich Trott <rtrott@gmail.com>2019-09-16 11:24:54 -0700
commite2dcbf1c3231513c38151d729f180a54ea902da9 (patch)
tree1f9197fb7c0af601c310a179ba089fdac8d6d5b5 /doc/api/vm.md
parent3d841fe20d732111094c3f62febd5a6b8b483b91 (diff)
downloadandroid-node-v8-e2dcbf1c3231513c38151d729f180a54ea902da9.tar.gz
android-node-v8-e2dcbf1c3231513c38151d729f180a54ea902da9.tar.bz2
android-node-v8-e2dcbf1c3231513c38151d729f180a54ea902da9.zip
doc: use consistent unordered list style
Convert to asterisks when there are mixed styles in document. Addresses Markdownlint MD004 rule PR-URL: https://github.com/nodejs/node/pull/29516 Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc/api/vm.md')
-rw-r--r--doc/api/vm.md36
1 files changed, 18 insertions, 18 deletions
diff --git a/doc/api/vm.md b/doc/api/vm.md
index cd0d3077e4..18ebd10a63 100644
--- a/doc/api/vm.md
+++ b/doc/api/vm.md
@@ -520,9 +520,9 @@ This must be called after the module has been instantiated; otherwise it will
throw an error. It could be called also when the module has already been
evaluated, in which case it will do one of the following two things:
-- return `undefined` if the initial evaluation ended in success (`module.status`
+* return `undefined` if the initial evaluation ended in success (`module.status`
is `'evaluated'`)
-- rethrow the same exception the initial evaluation threw if the initial
+* rethrow the same exception the initial evaluation threw if the initial
evaluation ended in an error (`module.status` is `'errored'`)
This method cannot be called while the module is being evaluated
@@ -570,8 +570,8 @@ The function is expected to return a `Module` object or a `Promise` that
eventually resolves to a `Module` object. The returned `Module` must satisfy the
following two invariants:
-- It must belong to the same context as the parent `Module`.
-- Its `linkingStatus` must not be `'errored'`.
+* It must belong to the same context as the parent `Module`.
+* Its `linkingStatus` must not be `'errored'`.
If the returned `Module`'s `linkingStatus` is `'unlinked'`, this method will be
recursively called on the returned `Module` with the same provided `linker`
@@ -585,9 +585,9 @@ The linker function roughly corresponds to the implementation-defined
[HostResolveImportedModule][] abstract operation in the ECMAScript
specification, with a few key differences:
-- The linker function is allowed to be asynchronous while
+* The linker function is allowed to be asynchronous while
[HostResolveImportedModule][] is synchronous.
-- The linker function is executed during linking, a Node.js-specific stage
+* The linker function is executed during linking, a Node.js-specific stage
before instantiation, while [HostResolveImportedModule][] is called during
instantiation.
@@ -603,12 +603,12 @@ specification.
The current linking status of `module`. It will be one of the following values:
-- `'unlinked'`: `module.link()` has not yet been called.
-- `'linking'`: `module.link()` has been called, but not all Promises returned by
+* `'unlinked'`: `module.link()` has not yet been called.
+* `'linking'`: `module.link()` has been called, but not all Promises returned by
the linker function have been resolved yet.
-- `'linked'`: `module.link()` has been called, and all its dependencies have
+* `'linked'`: `module.link()` has been called, and all its dependencies have
been successfully linked.
-- `'errored'`: `module.link()` has been called, but at least one of its
+* `'errored'`: `module.link()` has been called, but at least one of its
dependencies failed to link, either because the callback returned a `Promise`
that is rejected, or because the `Module` the callback returned is invalid.
@@ -628,28 +628,28 @@ specification.
The current status of the module. Will be one of:
-- `'uninstantiated'`: The module is not instantiated. It may because of any of
+* `'uninstantiated'`: The module is not instantiated. It may because of any of
the following reasons:
- - The module was just created.
- - `module.instantiate()` has been called on this module, but it failed for
+ * The module was just created.
+ * `module.instantiate()` has been called on this module, but it failed for
some reason.
This status does not convey any information regarding if `module.link()` has
been called. See `module.linkingStatus` for that.
-- `'instantiating'`: The module is currently being instantiated through a
+* `'instantiating'`: The module is currently being instantiated through a
`module.instantiate()` call on itself or a parent module.
-- `'instantiated'`: The module has been instantiated successfully, but
+* `'instantiated'`: The module has been instantiated successfully, but
`module.evaluate()` has not yet been called.
-- `'evaluating'`: The module is being evaluated through a `module.evaluate()` on
+* `'evaluating'`: The module is being evaluated through a `module.evaluate()` on
itself or a parent module.
-- `'evaluated'`: The module has been successfully evaluated.
+* `'evaluated'`: The module has been successfully evaluated.
-- `'errored'`: The module has been evaluated, but an exception was thrown.
+* `'errored'`: The module has been evaluated, but an exception was thrown.
Other than `'errored'`, this status string corresponds to the specification's
[Source Text Module Record][]'s `[[Status]]` field. `'errored'` corresponds to