V8 API Reference Guide for node.js v9.10.0 - v9.11.1
Public Types | Public Member Functions | List of all members
v8::Module Class Reference

#include <v8.h>

Public Types

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

Public Member Functions

Status GetStatus () const
 
Local< ValueGetException () const
 
int GetModuleRequestsLength () const
 
Local< StringGetModuleRequest (int i) const
 
Location GetModuleRequestLocation (int i) const
 
int GetIdentityHash () const
 
 V8_DEPRECATED ("Use Maybe<bool> version", bool Instantiate(Local< Context > context, ResolveCallback callback))
 
V8_WARN_UNUSED_RESULT Maybe< bool > InstantiateModule (Local< Context > context, ResolveCallback callback)
 
V8_WARN_UNUSED_RESULT MaybeLocal< ValueEvaluate (Local< Context > context)
 
Local< ValueGetModuleNamespace ()
 

Detailed Description

This is an unfinished experimental feature, and is only exposed here for internal testing purposes. DO NOT USE.

A compiled JavaScript module.

Member Enumeration Documentation

The different states a module can be in.

Member Function Documentation

V8_WARN_UNUSED_RESULT MaybeLocal<Value> v8::Module::Evaluate ( Local< Context context)

ModuleEvaluation

Returns the completion value. TODO(neis): Be more precise or say nothing.

Local<Value> v8::Module::GetException ( ) const

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

int v8::Module::GetIdentityHash ( ) const

Returns the identity hash for this object.

Local<Value> v8::Module::GetModuleNamespace ( )

Returns the namespace object of this module. The module's status must be kEvaluated.

Local<String> v8::Module::GetModuleRequest ( int  i) const

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

Location v8::Module::GetModuleRequestLocation ( int  i) const

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

int v8::Module::GetModuleRequestsLength ( ) const

Returns the number of modules requested by this module.

Status v8::Module::GetStatus ( ) const

Returns the module's current status.

v8::Module::V8_DEPRECATED ( "Use Maybe<bool> version"  ,
bool   InstantiateLocal< Context > context, ResolveCallback callback 
)

ModuleDeclarationInstantiation

Returns an empty Maybe<bool> if an exception occurred during instantiation. (In the case where the callback throws an exception, that exception is propagated.)


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