![]() |
v8 13.6.233 (node 24.1.0)
V8 is Google's open source JavaScript engine
|
#include <v8-script.h>


Public Types | |
| enum | Status { kUninstantiated , kInstantiating , kInstantiated , kEvaluating , kEvaluated , kErrored } |
| using | ResolveModuleCallback |
| using | ResolveSourceCallback |
| using | SyntheticModuleEvaluationSteps |
Static Public Member Functions | |
| static Local< Module > | CreateSyntheticModule (Isolate *isolate, Local< String > module_name, const MemorySpan< const Local< String > > &export_names, SyntheticModuleEvaluationSteps evaluation_steps) |
| static V8_INLINE Module * | Cast (Data *data) |
A compiled JavaScript module.
Definition at line 172 of file v8-script.h.
| using ResolveModuleCallback |
Definition at line 216 of file v8-script.h.
| using ResolveSourceCallback |
Definition at line 219 of file v8-script.h.
Definition at line 300 of file v8-script.h.
| enum Status |
The different states a module can be in.
This corresponds to the states used in ECMAScript except that "evaluated" is split into kEvaluated and kErrored, indicating success and failure, respectively.
| Enumerator | |
|---|---|
| kUninstantiated | |
| kInstantiating | |
| kInstantiated | |
| kEvaluating | |
| kEvaluated | |
| kErrored | |
Definition at line 181 of file v8-script.h.
Definition at line 943 of file v8-script.h.
Referenced by GetStalledTopLevelAwaitMessages().
|
static |
Creates a new SyntheticModule with the specified export names, where evaluation_steps will be executed upon module evaluation. export_names must not contain duplicates. module_name is used solely for logging/debugging and doesn't affect module behavior.
| V8_WARN_UNUSED_RESULT MaybeLocal< Value > Evaluate | ( | Local< Context > | context | ) |
Evaluates the module and its dependencies.
If status is kInstantiated, run the module's code and return a Promise object. On success, set status to kEvaluated and resolve the Promise with the completion value; on failure, set status to kErrored and reject the Promise with the error.
If IsGraphAsync() is false, the returned Promise is settled.
References V8_WARN_UNUSED_RESULT.
For a module in kErrored status, this returns the corresponding exception.
| int GetIdentityHash | ( | ) | const |
Returns the identity hash for this object.
Returns the namespace object of this module.
The module's status must be at least kInstantiated.
| Local< FixedArray > GetModuleRequests | ( | ) | const |
Returns the ModuleRequests for this module.
| std::pair< LocalVector< Module >, LocalVector< Message > > GetStalledTopLevelAwaitMessages | ( | Isolate * | isolate | ) |
Search the modules requested directly or indirectly by the module for any top-level await that has not yet resolved. If there is any, the returned pair of vectors (of equal size) contain the unresolved module and corresponding message with the pending top-level await. An embedder may call this before exiting to improve error messages.
| Status GetStatus | ( | ) | const |
Returns the module's current status.
| Local< UnboundModuleScript > GetUnboundModuleScript | ( | ) |
Returns the corresponding context-unbound module script.
The module must be unevaluated, i.e. its status must not be kEvaluating, kEvaluated or kErrored.
| bool HasTopLevelAwait | ( | ) | const |
Returns whether this module is individually asynchronous (for example, if it's a Source Text Module Record containing a top-level await). See [[HasTLA]] in https://tc39.es/ecma262/#sec-cyclic-module-records
| V8_WARN_UNUSED_RESULT Maybe< bool > InstantiateModule | ( | Local< Context > | context, |
| ResolveModuleCallback | module_callback, | ||
| ResolveSourceCallback | source_callback = nullptr ) |
Instantiates the module and its dependencies.
Returns an empty Maybe<bool> if an exception occurred during instantiation. (In the case where the callback throws an exception, that exception is propagated.)
References V8_WARN_UNUSED_RESULT.
| bool IsGraphAsync | ( | ) | const |
Returns whether this module or any of its requested modules is async, i.e. contains top-level await.
The module's status must be at least kInstantiated.
| bool IsSourceTextModule | ( | ) | const |
Returns whether the module is a SourceTextModule.
| bool IsSyntheticModule | ( | ) | const |
Returns whether the module is a SyntheticModule.
| int ScriptId | ( | ) | const |
Returns the underlying script's id.
The module must be a SourceTextModule and must not have a kErrored status.
| V8_WARN_UNUSED_RESULT Maybe< bool > SetSyntheticModuleExport | ( | Isolate * | isolate, |
| Local< String > | export_name, | ||
| Local< Value > | export_value ) |
Set this module's exported value for the name export_name to the specified export_value. This method must be called only on Modules created via CreateSyntheticModule. An error will be thrown if export_name is not one of the export_names that were passed in that CreateSyntheticModule call. Returns Just(true) on success, Nothing<bool>() if an error was thrown.
References V8_WARN_UNUSED_RESULT.
| Location SourceOffsetToLocation | ( | int | offset | ) | const |
For the given source text offset in this module, returns the corresponding Location with line and column numbers.