V8 Project
v8::Promise Class Reference

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

#include <v8.h>

+ Inheritance diagram for v8::Promise:
+ Collaboration diagram for v8::Promise:

Classes

class  Resolver
 

Public Member Functions

Local< PromiseChain (Handle< Function > handler)
 Register a resolution/rejection handler with a promise. More...
 
Local< PromiseCatch (Handle< Function > handler)
 
Local< PromiseThen (Handle< Function > handler)
 
- Public Member Functions inherited from v8::Object
bool Set (Handle< Value > key, Handle< Value > value)
 
bool Set (uint32_t index, Handle< Value > value)
 
bool ForceSet (Handle< Value > key, Handle< Value > value, PropertyAttribute attribs=None)
 
Local< ValueGet (Handle< Value > key)
 
Local< ValueGet (uint32_t index)
 
PropertyAttribute GetPropertyAttributes (Handle< Value > key)
 Gets the property attributes of a property which can be None or any combination of ReadOnly, DontEnum and DontDelete. More...
 
Local< ValueGetOwnPropertyDescriptor (Local< String > key)
 Returns Object.getOwnPropertyDescriptor as per ES5 section 15.2.3.3. More...
 
bool Has (Handle< Value > key)
 
bool Delete (Handle< Value > key)
 
bool ForceDelete (Handle< Value > key)
 
bool Has (uint32_t index)
 
bool Delete (uint32_t index)
 
bool SetAccessor (Handle< String > name, AccessorGetterCallback getter, AccessorSetterCallback setter=0, Handle< Value > data=Handle< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None)
 
bool SetAccessor (Handle< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=0, Handle< Value > data=Handle< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None)
 
bool SetDeclaredAccessor (Local< Name > name, Local< DeclaredAccessorDescriptor > descriptor, PropertyAttribute attribute=None, AccessControl settings=DEFAULT)
 
void SetAccessorProperty (Local< Name > name, Local< Function > getter, Handle< Function > setter=Handle< Function >(), PropertyAttribute attribute=None, AccessControl settings=DEFAULT)
 
bool HasPrivate (Handle< Private > key)
 Functionality for private properties. More...
 
bool SetPrivate (Handle< Private > key, Handle< Value > value)
 
bool DeletePrivate (Handle< Private > key)
 
Local< ValueGetPrivate (Handle< Private > key)
 
Local< ArrayGetPropertyNames ()
 Returns an array containing the names of the enumerable properties of this object, including properties from prototype objects. More...
 
Local< ArrayGetOwnPropertyNames ()
 This function has the same functionality as GetPropertyNames but the returned array doesn't contain the names of properties from prototype objects. More...
 
Local< ValueGetPrototype ()
 Get the prototype object. More...
 
bool SetPrototype (Handle< Value > prototype)
 Set the prototype object. More...
 
Local< ObjectFindInstanceInPrototypeChain (Handle< FunctionTemplate > tmpl)
 Finds an instance of the given function template in the prototype chain. More...
 
Local< StringObjectProtoToString ()
 Call builtin Object.prototype.toString on this object. More...
 
Local< StringGetConstructorName ()
 Returns the name of the function invoked as a constructor for this object. More...
 
int InternalFieldCount ()
 Gets the number of internal fields for this Object. More...
 
Local< ValueGetInternalField (int index)
 Gets the value from an internal field. More...
 
void SetInternalField (int index, Handle< Value > value)
 Sets the value in an internal field. More...
 
void * GetAlignedPointerFromInternalField (int index)
 Gets a 2-byte-aligned native pointer from an internal field. More...
 
void SetAlignedPointerInInternalField (int index, void *value)
 Sets a 2-byte-aligned native pointer in an internal field. More...
 
bool HasOwnProperty (Handle< String > key)
 
bool HasRealNamedProperty (Handle< String > key)
 
bool HasRealIndexedProperty (uint32_t index)
 
bool HasRealNamedCallbackProperty (Handle< String > key)
 
Local< ValueGetRealNamedPropertyInPrototypeChain (Handle< String > key)
 If result.IsEmpty() no real property was located in the prototype chain. More...
 
Local< ValueGetRealNamedProperty (Handle< String > key)
 If result.IsEmpty() no real property was located on the object or in the prototype chain. More...
 
bool HasNamedLookupInterceptor ()
 Tests for a named lookup interceptor. More...
 
bool HasIndexedLookupInterceptor ()
 Tests for an index lookup interceptor. More...
 
void TurnOnAccessCheck ()
 Turns on access check on the object if the object is an instance of a template that has access check callbacks. More...
 
int GetIdentityHash ()
 Returns the identity hash for this object. More...
 
bool SetHiddenValue (Handle< String > key, Handle< Value > value)
 Access hidden properties on JavaScript objects. More...
 
Local< ValueGetHiddenValue (Handle< String > key)
 
bool DeleteHiddenValue (Handle< String > key)
 
bool IsDirty ()
 Returns true if this is an instance of an api function (one created from a function created from a function template) and has been modified since it was created. More...
 
Local< ObjectClone ()
 Clone this object with a fast but shallow copy. More...
 
Local< ContextCreationContext ()
 Returns the context in which the object was created. More...
 
void SetIndexedPropertiesToPixelData (uint8_t *data, int length)
 Set the backing store of the indexed properties to be managed by the embedding layer. More...
 
bool HasIndexedPropertiesInPixelData ()
 
uint8_t * GetIndexedPropertiesPixelData ()
 
int GetIndexedPropertiesPixelDataLength ()
 
void SetIndexedPropertiesToExternalArrayData (void *data, ExternalArrayType array_type, int number_of_elements)
 Set the backing store of the indexed properties to be managed by the embedding layer. More...
 
bool HasIndexedPropertiesInExternalArrayData ()
 
void * GetIndexedPropertiesExternalArrayData ()
 
ExternalArrayType GetIndexedPropertiesExternalArrayDataType ()
 
int GetIndexedPropertiesExternalArrayDataLength ()
 
bool IsCallable ()
 Checks whether a callback is set by the ObjectTemplate::SetCallAsFunctionHandler method. More...
 
Local< ValueCallAsFunction (Handle< Value > recv, int argc, Handle< Value > argv[])
 Call an Object as a function if a callback is set by the ObjectTemplate::SetCallAsFunctionHandler method. More...
 
Local< ValueCallAsConstructor (int argc, Handle< Value > argv[])
 Call an Object as a constructor if a callback is set by the ObjectTemplate::SetCallAsFunctionHandler method. More...
 
- Public Member Functions inherited from v8::Value
bool IsUndefined () const
 Returns true if this value is the undefined value. More...
 
bool IsNull () const
 Returns true if this value is the null value. More...
 
bool IsTrue () const
 Returns true if this value is true. More...
 
bool IsFalse () const
 Returns true if this value is false. More...
 
bool IsName () const
 Returns true if this value is a symbol or a string. More...
 
bool IsString () const
 Returns true if this value is an instance of the String type. More...
 
bool IsSymbol () const
 Returns true if this value is a symbol. More...
 
bool IsFunction () const
 Returns true if this value is a function. More...
 
bool IsArray () const
 Returns true if this value is an array. More...
 
bool IsObject () const
 Returns true if this value is an object. More...
 
bool IsBoolean () const
 Returns true if this value is boolean. More...
 
bool IsNumber () const
 Returns true if this value is a number. More...
 
bool IsExternal () const
 Returns true if this value is external. More...
 
bool IsInt32 () const
 Returns true if this value is a 32-bit signed integer. More...
 
bool IsUint32 () const
 Returns true if this value is a 32-bit unsigned integer. More...
 
bool IsDate () const
 Returns true if this value is a Date. More...
 
bool IsArgumentsObject () const
 Returns true if this value is an Arguments object. More...
 
bool IsBooleanObject () const
 Returns true if this value is a Boolean object. More...
 
bool IsNumberObject () const
 Returns true if this value is a Number object. More...
 
bool IsStringObject () const
 Returns true if this value is a String object. More...
 
bool IsSymbolObject () const
 Returns true if this value is a Symbol object. More...
 
bool IsNativeError () const
 Returns true if this value is a NativeError. More...
 
bool IsRegExp () const
 Returns true if this value is a RegExp. More...
 
bool IsGeneratorFunction () const
 Returns true if this value is a Generator function. More...
 
bool IsGeneratorObject () const
 Returns true if this value is a Generator object (iterator). More...
 
bool IsPromise () const
 Returns true if this value is a Promise. More...
 
bool IsMap () const
 Returns true if this value is a Map. More...
 
bool IsSet () const
 Returns true if this value is a Set. More...
 
bool IsWeakMap () const
 Returns true if this value is a WeakMap. More...
 
bool IsWeakSet () const
 Returns true if this value is a WeakSet. More...
 
bool IsArrayBuffer () const
 Returns true if this value is an ArrayBuffer. More...
 
bool IsArrayBufferView () const
 Returns true if this value is an ArrayBufferView. More...
 
bool IsTypedArray () const
 Returns true if this value is one of TypedArrays. More...
 
bool IsUint8Array () const
 Returns true if this value is an Uint8Array. More...
 
bool IsUint8ClampedArray () const
 Returns true if this value is an Uint8ClampedArray. More...
 
bool IsInt8Array () const
 Returns true if this value is an Int8Array. More...
 
bool IsUint16Array () const
 Returns true if this value is an Uint16Array. More...
 
bool IsInt16Array () const
 Returns true if this value is an Int16Array. More...
 
bool IsUint32Array () const
 Returns true if this value is an Uint32Array. More...
 
bool IsInt32Array () const
 Returns true if this value is an Int32Array. More...
 
bool IsFloat32Array () const
 Returns true if this value is a Float32Array. More...
 
bool IsFloat64Array () const
 Returns true if this value is a Float64Array. More...
 
bool IsDataView () const
 Returns true if this value is a DataView. More...
 
Local< BooleanToBoolean () const
 
Local< NumberToNumber () const
 
Local< StringToString () const
 
Local< StringToDetailString () const
 
Local< ObjectToObject () const
 
Local< IntegerToInteger () const
 
Local< Uint32ToUint32 () const
 
Local< Int32ToInt32 () const
 
Local< Uint32ToArrayIndex () const
 Attempts to convert a string to an array index. More...
 
bool BooleanValue () const
 
double NumberValue () const
 
int64_t IntegerValue () const
 
uint32_t Uint32Value () const
 
int32_t Int32Value () const
 
bool Equals (Handle< Value > that) const
 JS ==. More...
 
bool StrictEquals (Handle< Value > that) const
 
bool SameValue (Handle< Value > that) const
 

Static Public Member Functions

static PromiseCast (Value *obj)
 
- Static Public Member Functions inherited from v8::Object
static int InternalFieldCount (const PersistentBase< Object > &object)
 Same as above, but works for Persistents. More...
 
static void * GetAlignedPointerFromInternalField (const PersistentBase< Object > &object, int index)
 Same as above, but works for Persistents. More...
 
static Local< ObjectNew (Isolate *isolate)
 
static ObjectCast (Value *obj)
 
- Static Public Member Functions inherited from v8::Value
template<class T >
static ValueCast (T *value)
 

Private Member Functions

 Promise ()
 

Static Private Member Functions

static void CheckCast (Value *obj)
 

Detailed Description

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

This API is experimental. Only works with –harmony flag.

Definition at line 2795 of file v8.h.

Constructor & Destructor Documentation

◆ Promise()

v8::Promise::Promise ( )
private

Member Function Documentation

◆ Cast()

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

Definition at line 6670 of file v8.h.

6670  {
6671 #ifdef V8_ENABLE_CHECKS
6672  CheckCast(value);
6673 #endif
6674  return static_cast<Promise*>(value);
6675 }
static void CheckCast(Value *obj)
Definition: api.cc:2770

◆ Catch()

Local< Promise > v8::Promise::Catch ( Handle< Function handler)

Definition at line 5949 of file api.cc.

5949  {
5950  i::Handle<i::JSObject> promise = Utils::OpenHandle(this);
5951  i::Isolate* isolate = promise->GetIsolate();
5952  LOG_API(isolate, "Promise::Catch");
5953  ENTER_V8(isolate);
5954  EXCEPTION_PREAMBLE(isolate);
5955  i::Handle<i::Object> argv[] = { Utils::OpenHandle(*handler) };
5956  i::Handle<i::Object> result;
5957  has_pending_exception = !i::Execution::Call(
5958  isolate,
5959  isolate->promise_catch(),
5960  promise,
5961  arraysize(argv), argv,
5962  false).ToHandle(&result);
5963  EXCEPTION_BAILOUT_CHECK(isolate, Local<Promise>());
5964  return Local<Promise>::Cast(Utils::ToLocal(result));
5965 }
#define LOG_API(isolate, expr)
Definition: api.cc:52
#define EXCEPTION_BAILOUT_CHECK(isolate, value)
Definition: api.cc:93
#define ENTER_V8(isolate)
Definition: api.cc:54
#define EXCEPTION_PREAMBLE(isolate)
Definition: api.cc:67
static Local< T > Cast(Local< S > that)
Definition: v8.h:348
static Local< Context > ToLocal(v8::internal::Handle< v8::internal::Context > obj)
static v8::internal::Handle< To > OpenHandle(v8::Local< From > handle)
Definition: api.h:288
#define arraysize(array)
Definition: macros.h:86

References arraysize, v8::Local< T >::Cast(), ENTER_V8, EXCEPTION_BAILOUT_CHECK, EXCEPTION_PREAMBLE, LOG_API, v8::Utils::OpenHandle(), and v8::Utils::ToLocal().

+ Here is the call graph for this function:

◆ Chain()

Local< Promise > v8::Promise::Chain ( Handle< 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.

Definition at line 5930 of file api.cc.

5930  {
5931  i::Handle<i::JSObject> promise = Utils::OpenHandle(this);
5932  i::Isolate* isolate = promise->GetIsolate();
5933  LOG_API(isolate, "Promise::Chain");
5934  ENTER_V8(isolate);
5935  EXCEPTION_PREAMBLE(isolate);
5936  i::Handle<i::Object> argv[] = { Utils::OpenHandle(*handler) };
5937  i::Handle<i::Object> result;
5938  has_pending_exception = !i::Execution::Call(
5939  isolate,
5940  isolate->promise_chain(),
5941  promise,
5942  arraysize(argv), argv,
5943  false).ToHandle(&result);
5944  EXCEPTION_BAILOUT_CHECK(isolate, Local<Promise>());
5945  return Local<Promise>::Cast(Utils::ToLocal(result));
5946 }

References arraysize, v8::Local< T >::Cast(), ENTER_V8, EXCEPTION_BAILOUT_CHECK, EXCEPTION_PREAMBLE, LOG_API, v8::Utils::OpenHandle(), and v8::Utils::ToLocal().

+ Here is the call graph for this function:

◆ CheckCast()

void v8::Promise::CheckCast ( Value obj)
staticprivate

Definition at line 2770 of file api.cc.

2770  {
2771  Utils::ApiCheck(that->IsPromise(),
2772  "v8::Promise::Cast()",
2773  "Could not convert to promise");
2774 }
static bool ApiCheck(bool condition, const char *location, const char *message)
Definition: api.h:177

References v8::Utils::ApiCheck(), and v8::Value::IsPromise().

+ Here is the call graph for this function:

◆ Then()

Local< Promise > v8::Promise::Then ( Handle< Function handler)

Definition at line 5968 of file api.cc.

5968  {
5969  i::Handle<i::JSObject> promise = Utils::OpenHandle(this);
5970  i::Isolate* isolate = promise->GetIsolate();
5971  LOG_API(isolate, "Promise::Then");
5972  ENTER_V8(isolate);
5973  EXCEPTION_PREAMBLE(isolate);
5974  i::Handle<i::Object> argv[] = { Utils::OpenHandle(*handler) };
5975  i::Handle<i::Object> result;
5976  has_pending_exception = !i::Execution::Call(
5977  isolate,
5978  isolate->promise_then(),
5979  promise,
5980  arraysize(argv), argv,
5981  false).ToHandle(&result);
5982  EXCEPTION_BAILOUT_CHECK(isolate, Local<Promise>());
5983  return Local<Promise>::Cast(Utils::ToLocal(result));
5984 }

References arraysize, v8::Local< T >::Cast(), ENTER_V8, EXCEPTION_BAILOUT_CHECK, EXCEPTION_PREAMBLE, LOG_API, v8::Utils::OpenHandle(), and v8::Utils::ToLocal().

+ Here is the call graph for this function:

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