#include <v8-promise.h>

Inheritance diagram for v8::Promise:

Collaboration diagram for v8::Promise:

Classes
class	Resolver

Public Types
enum	PromiseState { kPending , kFulfilled , kRejected }

Public Member Functions
MaybeLocal< Promise >	Catch (Local< Context > context, Local< Function > handler)

MaybeLocal< Promise >	Then (Local< Context > context, Local< Function > handler)

MaybeLocal< Promise >	Then (Local< Context > context, Local< Function > on_fulfilled, Local< Function > on_rejected)

bool	HasHandler () const

Local< Value >	Result ()

PromiseState	State ()

void	MarkAsHandled ()

void	MarkAsSilent ()

Public Member Functions inherited from v8::Object
Maybe< bool >	Set (Local< Context > context, Local< Value > key, Local< Value > value)

Maybe< bool >	Set (Local< Context > context, Local< Value > key, Local< Value > value, MaybeLocal< Object > receiver)

Maybe< bool >	Set (Local< Context > context, uint32_t index, Local< Value > value)

Maybe< bool >	CreateDataProperty (Local< Context > context, Local< Name > key, Local< Value > value)

Maybe< bool >	CreateDataProperty (Local< Context > context, uint32_t index, Local< Value > value)

Maybe< bool >	DefineOwnProperty (Local< Context > context, Local< Name > key, Local< Value > value, PropertyAttribute attributes=None)

Maybe< bool >	DefineProperty (Local< Context > context, Local< Name > key, PropertyDescriptor &descriptor)

MaybeLocal< Value >	Get (Local< Context > context, Local< Value > key)

MaybeLocal< Value >	Get (Local< Context > context, Local< Value > key, MaybeLocal< Object > receiver)

MaybeLocal< Value >	Get (Local< Context > context, uint32_t index)

Maybe< PropertyAttribute >	GetPropertyAttributes (Local< Context > context, Local< Value > key)

MaybeLocal< Value >	GetOwnPropertyDescriptor (Local< Context > context, Local< Name > key)

Maybe< bool >	Has (Local< Context > context, Local< Value > key)

Maybe< bool >	Delete (Local< Context > context, Local< Value > key)

Maybe< bool >	Has (Local< Context > context, uint32_t index)

Maybe< bool >	Delete (Local< Context > context, uint32_t index)

void	SetAccessorProperty (Local< Name > name, Local< Function > getter, Local< Function > setter=Local< Function >(), PropertyAttribute attributes=None)

Maybe< bool >	SetNativeDataProperty (Local< Context > context, Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=nullptr, Local< Value > data=Local< Value >(), PropertyAttribute attributes=None, SideEffectType getter_side_effect_type=SideEffectType::kHasSideEffect, SideEffectType setter_side_effect_type=SideEffectType::kHasSideEffect)

Maybe< bool >	SetLazyDataProperty (Local< Context > context, Local< Name > name, AccessorNameGetterCallback getter, Local< Value > data=Local< Value >(), PropertyAttribute attributes=None, SideEffectType getter_side_effect_type=SideEffectType::kHasSideEffect, SideEffectType setter_side_effect_type=SideEffectType::kHasSideEffect)

Maybe< bool >	HasPrivate (Local< Context > context, Local< Private > key)

Maybe< bool >	SetPrivate (Local< Context > context, Local< Private > key, Local< Value > value)

Maybe< bool >	DeletePrivate (Local< Context > context, Local< Private > key)

MaybeLocal< Value >	GetPrivate (Local< Context > context, Local< Private > key)

MaybeLocal< Array >	GetPropertyNames (Local< Context > context)

MaybeLocal< Array >	GetPropertyNames (Local< Context > context, KeyCollectionMode mode, PropertyFilter property_filter, IndexFilter index_filter, KeyConversionMode key_conversion=KeyConversionMode::kKeepNumbers)

MaybeLocal< Array >	GetOwnPropertyNames (Local< Context > context)

MaybeLocal< Array >	GetOwnPropertyNames (Local< Context > context, PropertyFilter filter, KeyConversionMode key_conversion=KeyConversionMode::kKeepNumbers)

Local< Value >	GetPrototype ()

Local< Value >	GetPrototypeV2 ()

Maybe< bool >	SetPrototype (Local< Context > context, Local< Value > prototype)

Maybe< bool >	SetPrototypeV2 (Local< Context > context, Local< Value > prototype)

Local< Object >	FindInstanceInPrototypeChain (Local< FunctionTemplate > tmpl)

MaybeLocal< String >	ObjectProtoToString (Local< Context > context)

Local< String >	GetConstructorName ()

Maybe< bool >	SetIntegrityLevel (Local< Context > context, IntegrityLevel level)

int	InternalFieldCount () const

Local< Data >	GetInternalField (int index)

void	SetInternalField (int index, Local< Data > data)

void *	GetAlignedPointerFromInternalField (int index)

void *	GetAlignedPointerFromInternalField (v8::Isolate *isolate, int index)

void	SetAlignedPointerInInternalField (int index, void *value)

void	SetAlignedPointerInInternalFields (int argc, int indices[], void *values[])

Maybe< bool >	HasOwnProperty (Local< Context > context, Local< Name > key)

Maybe< bool >	HasOwnProperty (Local< Context > context, uint32_t index)

Maybe< bool >	HasRealNamedProperty (Local< Context > context, Local< Name > key)

Maybe< bool >	HasRealIndexedProperty (Local< Context > context, uint32_t index)

Maybe< bool >	HasRealNamedCallbackProperty (Local< Context > context, Local< Name > key)

MaybeLocal< Value >	GetRealNamedPropertyInPrototypeChain (Local< Context > context, Local< Name > key)

Maybe< PropertyAttribute >	GetRealNamedPropertyAttributesInPrototypeChain (Local< Context > context, Local< Name > key)

MaybeLocal< Value >	GetRealNamedProperty (Local< Context > context, Local< Name > key)

Maybe< PropertyAttribute >	GetRealNamedPropertyAttributes (Local< Context > context, Local< Name > key)

bool	HasNamedLookupInterceptor () const

bool	HasIndexedLookupInterceptor () const

int	GetIdentityHash ()

Local< Object >	Clone (v8::Isolate *isolate)

Local< Object >	Clone ()

MaybeLocal< Context >	GetCreationContext (v8::Isolate *isolate)

MaybeLocal< Context >	GetCreationContext ()

Local< Context >	GetCreationContextChecked (v8::Isolate *isolate)

Local< Context >	GetCreationContextChecked ()

void *	GetAlignedPointerFromEmbedderDataInCreationContext (v8::Isolate *isolate, int index)

void *	GetAlignedPointerFromEmbedderDataInCreationContext (int index)

bool	IsCallable () const

bool	IsConstructor () const

bool	IsApiWrapper () const

bool	IsUndetectable () const

MaybeLocal< Value >	CallAsFunction (Local< Context > context, Local< Value > recv, int argc, Local< Value > argv[])

MaybeLocal< Value >	CallAsConstructor (Local< Context > context, int argc, Local< Value > argv[])

Isolate *	GetIsolate ()

MaybeLocal< Array >	PreviewEntries (bool *is_key_value)

bool	IsCodeLike (Isolate *isolate) const

Public Member Functions inherited from v8::Value
bool	IsUndefined () const

bool	IsNull () const

bool	IsNullOrUndefined () const

bool	IsTrue () const

bool	IsFalse () const

bool	IsName () const

bool	IsString () const

bool	IsSymbol () const

bool	IsFunction () const

bool	IsArray () const

bool	IsObject () const

bool	IsBigInt () const

bool	IsBoolean () const

bool	IsNumber () const

bool	IsExternal () const

bool	IsInt32 () const

bool	IsUint32 () const

bool	IsDate () const

bool	IsArgumentsObject () const

bool	IsBigIntObject () const

bool	IsBooleanObject () const

bool	IsNumberObject () const

bool	IsStringObject () const

bool	IsSymbolObject () const

bool	IsNativeError () const

bool	IsRegExp () const

bool	IsAsyncFunction () const

bool	IsGeneratorFunction () const

bool	IsGeneratorObject () const

bool	IsPromise () const

bool	IsMap () const

bool	IsSet () const

bool	IsMapIterator () const

bool	IsSetIterator () const

bool	IsWeakMap () const

bool	IsWeakSet () const

bool	IsWeakRef () const

bool	IsArrayBuffer () const

bool	IsArrayBufferView () const

bool	IsTypedArray () const

bool	IsUint8Array () const

bool	IsUint8ClampedArray () const

bool	IsInt8Array () const

bool	IsUint16Array () const

bool	IsInt16Array () const

bool	IsUint32Array () const

bool	IsInt32Array () const

bool	IsFloat16Array () const

bool	IsFloat32Array () const

bool	IsFloat64Array () const

bool	IsBigInt64Array () const

bool	IsBigUint64Array () const

bool	IsDataView () const

bool	IsSharedArrayBuffer () const

bool	IsProxy () const

bool	IsWasmMemoryObject () const

bool	IsWasmMemoryMapDescriptor () const

bool	IsWasmModuleObject () const

bool	IsWasmNull () const

bool	IsModuleNamespaceObject () const

MaybeLocal< Primitive >	ToPrimitive (Local< Context > context) const

MaybeLocal< Numeric >	ToNumeric (Local< Context > context) const

MaybeLocal< BigInt >	ToBigInt (Local< Context > context) const

MaybeLocal< Number >	ToNumber (Local< Context > context) const

MaybeLocal< String >	ToString (Local< Context > context) const

MaybeLocal< String >	ToDetailString (Local< Context > context) const

MaybeLocal< Object >	ToObject (Local< Context > context) const

MaybeLocal< Integer >	ToInteger (Local< Context > context) const

MaybeLocal< Uint32 >	ToUint32 (Local< Context > context) const

MaybeLocal< Int32 >	ToInt32 (Local< Context > context) const

Local< Boolean >	ToBoolean (Isolate *isolate) const

MaybeLocal< Uint32 >	ToArrayIndex (Local< Context > context) const

bool	BooleanValue (Isolate *isolate) const

Maybe< double >	NumberValue (Local< Context > context) const

Maybe< int64_t >	IntegerValue (Local< Context > context) const

Maybe< uint32_t >	Uint32Value (Local< Context > context) const

Maybe< int32_t >	Int32Value (Local< Context > context) const

Maybe< bool >	Equals (Local< Context > context, Local< Value > that) const

bool	StrictEquals (Local< Value > that) const

bool	SameValue (Local< Value > that) const

Local< String >	TypeOf (Isolate *)

Maybe< bool >	InstanceOf (Local< Context > context, Local< Object > object)

template<>
Value *	Cast (Data *value)

Public Member Functions inherited from v8::Data
bool	IsValue () const

bool	IsModule () const

bool	IsFixedArray () const

bool	IsPrivate () const

bool	IsObjectTemplate () const

bool	IsFunctionTemplate () const

bool	IsContext () const

Static Public Member Functions
static Promise *	Cast (Value *value)

Static Public Member Functions inherited from v8::Object
static int	InternalFieldCount (const PersistentBase< Object > &object)

static int	InternalFieldCount (const BasicTracedReference< Object > &object)

static void *	GetAlignedPointerFromInternalField (const PersistentBase< Object > &object, int index)

static void *	GetAlignedPointerFromInternalField (const BasicTracedReference< Object > &object, int index)

template<CppHeapPointerTag tag, typename T = void>
static T *	Unwrap (v8::Isolate *isolate, const v8::Local< v8::Object > &wrapper)

template<CppHeapPointerTag tag, typename T = void>
static T *	Unwrap (v8::Isolate *isolate, const PersistentBase< Object > &wrapper)

template<CppHeapPointerTag tag, typename T = void>
static T *	Unwrap (v8::Isolate *isolate, const BasicTracedReference< Object > &wrapper)

template<typename T = void>
static T *	Unwrap (v8::Isolate *isolate, const v8::Local< v8::Object > &wrapper, CppHeapPointerTagRange tag_range)

template<typename T = void>
static T *	Unwrap (v8::Isolate *isolate, const PersistentBase< Object > &wrapper, CppHeapPointerTagRange tag_range)

template<typename T = void>
static T *	Unwrap (v8::Isolate *isolate, const BasicTracedReference< Object > &wrapper, CppHeapPointerTagRange tag_range)

template<CppHeapPointerTag tag>
static void	Wrap (v8::Isolate isolate, const v8::Local< v8::Object > &wrapper, void wrappable)

template<CppHeapPointerTag tag>
static void	Wrap (v8::Isolate isolate, const PersistentBase< Object > &wrapper, void wrappable)

template<CppHeapPointerTag tag>
static void	Wrap (v8::Isolate isolate, const BasicTracedReference< Object > &wrapper, void wrappable)

static void	Wrap (v8::Isolate isolate, const v8::Local< v8::Object > &wrapper, void wrappable, CppHeapPointerTag tag)

static void	Wrap (v8::Isolate isolate, const PersistentBase< Object > &wrapper, void wrappable, CppHeapPointerTag tag)

static void	Wrap (v8::Isolate isolate, const BasicTracedReference< Object > &wrapper, void wrappable, CppHeapPointerTag tag)

static MaybeLocal< Context >	GetCreationContext (v8::Isolate *isolate, const PersistentBase< Object > &object)

static MaybeLocal< Context >	GetCreationContext (const PersistentBase< Object > &object)

static Isolate *	GetIsolate (const TracedReference< Object > &handle)

static Local< Object >	New (Isolate *isolate)

static Local< Object >	New (Isolate isolate, Local< Value > prototype_or_null, Local< Name > names, Local< Value > *values, size_t length)

static Object *	Cast (Value *obj)

Static Public Member Functions inherited from v8::Value
template<class T >
static Value *	Cast (T *value)

Static Public Attributes
static constexpr int	kEmbedderFieldCount = 0

Detailed Description

An instance of the built-in Promise constructor (ES6 draft).

Member Enumeration Documentation

◆ PromiseState

enum v8::Promise::PromiseState

State of the promise. Each value corresponds to one of the possible values of the [[PromiseState]] field.

Enumerator
kPending
kFulfilled
kRejected

Member Function Documentation

◆ Cast()

static Promise * v8::Promise::Cast ( Value * value )

inlinestatic

◆ Catch()

MaybeLocal< Promise > v8::Promise::Catch	(	Local< Context >	context,
		Local< Function >	handler
	)

Register a resolution/rejection handler with a promise. The handler is given the respective resolution/rejection value as an argument. If the promise is already resolved/rejected, the handler is invoked at the end of turn.

◆ HasHandler()

bool v8::Promise::HasHandler ( ) const

Returns true if the promise has at least one derived promise, and therefore resolve/reject handlers (including default handler).

◆ MarkAsHandled()

void v8::Promise::MarkAsHandled ( )

Marks this promise as handled to avoid reporting unhandled rejections.

◆ MarkAsSilent()

void v8::Promise::MarkAsSilent ( )

Marks this promise as silent to prevent pausing the debugger when the promise is rejected.

◆ Result()

Local< Value > v8::Promise::Result ( )

Returns the content of the [[PromiseResult]] field. The Promise must not be pending.

◆ State()

PromiseState v8::Promise::State ( )

Returns the value of the [[PromiseState]] field.

◆ Then() [1/2]

MaybeLocal< Promise > v8::Promise::Then	(	Local< Context >	context,
		Local< Function >	handler
	)

◆ Then() [2/2]

MaybeLocal< Promise > v8::Promise::Then	(	Local< Context >	context,
		Local< Function >	on_fulfilled,
		Local< Function >	on_rejected
	)

Member Data Documentation

◆ kEmbedderFieldCount

constexpr int v8::Promise::kEmbedderFieldCount = 0

staticconstexpr

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

include/v8-promise.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes