Skip to content

Commit 5e562fd

Browse files
vsemozhetbyttargos
authored andcommitted
doc: fix sorting in the vm.Module section
PR-URL: #21931 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
1 parent cfeed2b commit 5e562fd

File tree

1 file changed

+65
-65
lines changed

1 file changed

+65
-65
lines changed

doc/api/vm.md

+65-65
Original file line numberDiff line numberDiff line change
@@ -234,71 +234,6 @@ exception due to possible ambiguity with `throw undefined;`.
234234
Corresponds to the `[[EvaluationError]]` field of [Source Text Module Record][]s
235235
in the ECMAScript specification.
236236

237-
### module.linkingStatus
238-
239-
* {string}
240-
241-
The current linking status of `module`. It will be one of the following values:
242-
243-
- `'unlinked'`: `module.link()` has not yet been called.
244-
- `'linking'`: `module.link()` has been called, but not all Promises returned by
245-
the linker function have been resolved yet.
246-
- `'linked'`: `module.link()` has been called, and all its dependencies have
247-
been successfully linked.
248-
- `'errored'`: `module.link()` has been called, but at least one of its
249-
dependencies failed to link, either because the callback returned a `Promise`
250-
that is rejected, or because the `Module` the callback returned is invalid.
251-
252-
### module.namespace
253-
254-
* {Object}
255-
256-
The namespace object of the module. This is only available after instantiation
257-
(`module.instantiate()`) has completed.
258-
259-
Corresponds to the [GetModuleNamespace][] abstract operation in the ECMAScript
260-
specification.
261-
262-
### module.status
263-
264-
* {string}
265-
266-
The current status of the module. Will be one of:
267-
268-
- `'uninstantiated'`: The module is not instantiated. It may because of any of
269-
the following reasons:
270-
271-
- The module was just created.
272-
- `module.instantiate()` has been called on this module, but it failed for
273-
some reason.
274-
275-
This status does not convey any information regarding if `module.link()` has
276-
been called. See `module.linkingStatus` for that.
277-
278-
- `'instantiating'`: The module is currently being instantiated through a
279-
`module.instantiate()` call on itself or a parent module.
280-
281-
- `'instantiated'`: The module has been instantiated successfully, but
282-
`module.evaluate()` has not yet been called.
283-
284-
- `'evaluating'`: The module is being evaluated through a `module.evaluate()` on
285-
itself or a parent module.
286-
287-
- `'evaluated'`: The module has been successfully evaluated.
288-
289-
- `'errored'`: The module has been evaluated, but an exception was thrown.
290-
291-
Other than `'errored'`, this status string corresponds to the specification's
292-
[Source Text Module Record][]'s `[[Status]]` field. `'errored'` corresponds to
293-
`'evaluated'` in the specification, but with `[[EvaluationError]]` set to a
294-
value that is not `undefined`.
295-
296-
### module.url
297-
298-
* {string}
299-
300-
The URL of the current module, as set in the constructor.
301-
302237
### module.evaluate([options])
303238

304239
* `options` {Object}
@@ -395,6 +330,71 @@ that point all modules would have been fully linked already, the
395330
[HostResolveImportedModule][] implementation is fully synchronous per
396331
specification.
397332

333+
### module.linkingStatus
334+
335+
* {string}
336+
337+
The current linking status of `module`. It will be one of the following values:
338+
339+
- `'unlinked'`: `module.link()` has not yet been called.
340+
- `'linking'`: `module.link()` has been called, but not all Promises returned by
341+
the linker function have been resolved yet.
342+
- `'linked'`: `module.link()` has been called, and all its dependencies have
343+
been successfully linked.
344+
- `'errored'`: `module.link()` has been called, but at least one of its
345+
dependencies failed to link, either because the callback returned a `Promise`
346+
that is rejected, or because the `Module` the callback returned is invalid.
347+
348+
### module.namespace
349+
350+
* {Object}
351+
352+
The namespace object of the module. This is only available after instantiation
353+
(`module.instantiate()`) has completed.
354+
355+
Corresponds to the [GetModuleNamespace][] abstract operation in the ECMAScript
356+
specification.
357+
358+
### module.status
359+
360+
* {string}
361+
362+
The current status of the module. Will be one of:
363+
364+
- `'uninstantiated'`: The module is not instantiated. It may because of any of
365+
the following reasons:
366+
367+
- The module was just created.
368+
- `module.instantiate()` has been called on this module, but it failed for
369+
some reason.
370+
371+
This status does not convey any information regarding if `module.link()` has
372+
been called. See `module.linkingStatus` for that.
373+
374+
- `'instantiating'`: The module is currently being instantiated through a
375+
`module.instantiate()` call on itself or a parent module.
376+
377+
- `'instantiated'`: The module has been instantiated successfully, but
378+
`module.evaluate()` has not yet been called.
379+
380+
- `'evaluating'`: The module is being evaluated through a `module.evaluate()` on
381+
itself or a parent module.
382+
383+
- `'evaluated'`: The module has been successfully evaluated.
384+
385+
- `'errored'`: The module has been evaluated, but an exception was thrown.
386+
387+
Other than `'errored'`, this status string corresponds to the specification's
388+
[Source Text Module Record][]'s `[[Status]]` field. `'errored'` corresponds to
389+
`'evaluated'` in the specification, but with `[[EvaluationError]]` set to a
390+
value that is not `undefined`.
391+
392+
### module.url
393+
394+
* {string}
395+
396+
The URL of the current module, as set in the constructor.
397+
398398
## Class: vm.Script
399399
<!-- YAML
400400
added: v0.3.1

0 commit comments

Comments
 (0)