Module Class Reference

#include <v8.h>

Inheritance diagram for Module:

Collaboration diagram for Module:

Public Types
enum	Status {   kUninstantiated, kInstantiating, kInstantiated, kEvaluating,   kEvaluated, kErrored }
typedef MaybeLocal< Module >(*	ResolveCallback) (Local< Context > context, Local< String > specifier, Local< Module > referrer)
typedef MaybeLocal< Value >(*	SyntheticModuleEvaluationSteps) (Local< Context > context, Local< Module > module)

Public Member Functions
Status	GetStatus () const
Local< Value >	GetException () const
int	GetModuleRequestsLength () const
Local< String >	GetModuleRequest (int i) const
Location	GetModuleRequestLocation (int i) const
int	GetIdentityHash () const
V8_WARN_UNUSED_RESULT Maybe< bool >	InstantiateModule (Local< Context > context, ResolveCallback callback)
V8_WARN_UNUSED_RESULT MaybeLocal< Value >	Evaluate (Local< Context > context)
Local< Value >	GetModuleNamespace ()
Local< UnboundModuleScript >	GetUnboundModuleScript ()
V8_WARN_UNUSED_RESULT Maybe< bool >	SetSyntheticModuleExport (Isolate *isolate, Local< String > export_name, Local< Value > export_value)
	V8_DEPRECATE_SOON ("Use the preceding SetSyntheticModuleExport with an Isolate parameter, " "instead of the one that follows. The former will throw a runtime " "error if called for an export that doesn't exist (as per spec); " "the latter will crash with a failed CHECK().") void SetSyntheticModuleExport(Local< String > export_name

Static Public Member Functions
static Local< Module >	CreateSyntheticModule (Isolate *isolate, Local< String > module_name, const std::vector< Local< String >> &export_names, SyntheticModuleEvaluationSteps evaluation_steps)

Data Fields
Local< Value >	export_value

Detailed Description

A compiled JavaScript module.

Definition at line 1476 of file v8.h.

Member Typedef Documentation

ResolveCallback

typedef MaybeLocal<Module>(* ResolveCallback) (Local< Context > context, Local< String > specifier, Local< Module > referrer)

Definition at line 1526 of file v8.h.

SyntheticModuleEvaluationSteps

typedef MaybeLocal<Value>(* SyntheticModuleEvaluationSteps) (Local< Context > context, Local< Module > module)

Definition at line 1572 of file v8.h.

Member Enumeration Documentation

Status

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 1485 of file v8.h.

Member Function Documentation

CreateSyntheticModule()

static Local<Module> CreateSyntheticModule ( Isolate *  isolate, Local< String >  module_name, const std::vector< Local< String >> &  export_names, SyntheticModuleEvaluationSteps  evaluation_steps  )

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.

Evaluate()

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. On success, set status to kEvaluated and return the completion value; on failure, set status to kErrored and propagate the thrown exception (which is then also available via |GetException|).

GetException()

Local<Value> GetException

(

)

const

For a module in kErrored status, this returns the corresponding exception.

GetIdentityHash()

int GetIdentityHash

(

)

const

Returns the identity hash for this object.

GetModuleNamespace()

Local<Value> GetModuleNamespace

(

)

Returns the namespace object of this module.

The module's status must be at least kInstantiated.

GetModuleRequest()

Local<String> GetModuleRequest

(

int

i

)

const

Returns the ith module specifier in this module. i must be < GetModuleRequestsLength() and >= 0.

GetModuleRequestLocation()

Location GetModuleRequestLocation

(

int

i

)

const

Returns the source location (line number and column number) of the ith module specifier's first occurrence in this module.

GetModuleRequestsLength()

int GetModuleRequestsLength

(

)

const

Returns the number of modules requested by this module.

GetStatus()

Status GetStatus

(

)

const

Returns the module's current status.

GetUnboundModuleScript()

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.

InstantiateModule()

V8_WARN_UNUSED_RESULT Maybe<bool> InstantiateModule	(	Local< Context >	context,
		ResolveCallback	callback
	)

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.)

SetSyntheticModuleExport()

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.

V8_DEPRECATE_SOON()

V8_DEPRECATE_SOON	(	"Use the preceding SetSyntheticModuleExport with an Isolate	parameter,
		" "instead of the one that follows. The former will throw a runtime " "error if called for an export that doesn 't exist(as per spec);" "the latter will crash with a failed CHECK()."
	)

Field Documentation

export_value

Local<Value> export_value

Definition at line 1602 of file v8.h.

---

The documentation for this class was generated from the following file:

• include/v8.h