V8 API Reference Guide for node.js v4.8.1 - v4.8.2
Public Member Functions | Static Public Member Functions | List of all members
v8::Object Class Reference

#include <v8.h>

Inheritance diagram for v8::Object:
Inheritance graph
[legend]
Collaboration diagram for v8::Object:
Collaboration graph
[legend]

Public Member Functions

 V8_DEPRECATE_SOON ("Use maybe version", bool Set(Local< Value > key, Local< Value > value))
 
V8_WARN_UNUSED_RESULT Maybe< bool > Set (Local< Context > context, Local< Value > key, Local< Value > value)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool Set(uint32_t index, Local< Value > value))
 
V8_WARN_UNUSED_RESULT Maybe< bool > Set (Local< Context > context, uint32_t index, Local< Value > value)
 
V8_WARN_UNUSED_RESULT Maybe< bool > CreateDataProperty (Local< Context > context, Local< Name > key, Local< Value > value)
 
V8_WARN_UNUSED_RESULT Maybe< bool > CreateDataProperty (Local< Context > context, uint32_t index, Local< Value > value)
 
V8_WARN_UNUSED_RESULT Maybe< bool > DefineOwnProperty (Local< Context > context, Local< Name > key, Local< Value > value, PropertyAttribute attributes=None)
 
 V8_DEPRECATE_SOON ("Use CreateDataProperty", bool ForceSet(Local< Value > key, Local< Value > value, PropertyAttribute attribs=None))
 
 V8_DEPRECATE_SOON ("Use CreateDataProperty", Maybe< bool > ForceSet(Local< Context > context, Local< Value > key, Local< Value > value, PropertyAttribute attribs=None))
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Value > Get(Local< Value > key))
 
V8_WARN_UNUSED_RESULT MaybeLocal< ValueGet (Local< Context > context, Local< Value > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Value > Get(uint32_t index))
 
V8_WARN_UNUSED_RESULT MaybeLocal< ValueGet (Local< Context > context, uint32_t index)
 
 V8_DEPRECATE_SOON ("Use maybe version", PropertyAttribute GetPropertyAttributes(Local< Value > key))
 
V8_WARN_UNUSED_RESULT Maybe< PropertyAttribute > GetPropertyAttributes (Local< Context > context, Local< Value > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Value > GetOwnPropertyDescriptor(Local< String > key))
 
V8_WARN_UNUSED_RESULT MaybeLocal< ValueGetOwnPropertyDescriptor (Local< Context > context, Local< String > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool Has(Local< Value > key))
 
V8_WARN_UNUSED_RESULT Maybe< bool > Has (Local< Context > context, Local< Value > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool Delete(Local< Value > key))
 
Maybe< bool > Delete (Local< Context > context, Local< Value > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool Has(uint32_t index))
 
V8_WARN_UNUSED_RESULT Maybe< bool > Has (Local< Context > context, uint32_t index)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool Delete(uint32_t index))
 
Maybe< bool > Delete (Local< Context > context, uint32_t index)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool SetAccessor(Local< String > name, AccessorGetterCallback getter, AccessorSetterCallback setter=0, Local< Value > data=Local< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None))
 
 V8_DEPRECATE_SOON ("Use maybe version", bool SetAccessor(Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=0, Local< Value > data=Local< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None))
 
Maybe< bool > SetAccessor (Local< Context > context, Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=0, MaybeLocal< Value > data=MaybeLocal< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None)
 
void SetAccessorProperty (Local< Name > name, Local< Function > getter, Local< Function > setter=Local< Function >(), PropertyAttribute attribute=None, AccessControl settings=DEFAULT)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Array > GetPropertyNames())
 
V8_WARN_UNUSED_RESULT MaybeLocal< ArrayGetPropertyNames (Local< Context > context)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Array > GetOwnPropertyNames())
 
V8_WARN_UNUSED_RESULT MaybeLocal< ArrayGetOwnPropertyNames (Local< Context > context)
 
Local< ValueGetPrototype ()
 
 V8_DEPRECATE_SOON ("Use maybe version", bool SetPrototype(Local< Value > prototype))
 
V8_WARN_UNUSED_RESULT Maybe< bool > SetPrototype (Local< Context > context, Local< Value > prototype)
 
Local< ObjectFindInstanceInPrototypeChain (Local< FunctionTemplate > tmpl)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< String > ObjectProtoToString())
 
V8_WARN_UNUSED_RESULT MaybeLocal< StringObjectProtoToString (Local< Context > context)
 
Local< StringGetConstructorName ()
 
int InternalFieldCount ()
 
V8_INLINE Local< ValueGetInternalField (int index)
 
void SetInternalField (int index, Local< Value > value)
 
V8_INLINE void * GetAlignedPointerFromInternalField (int index)
 
void SetAlignedPointerInInternalField (int index, void *value)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool HasOwnProperty(Local< String > key))
 
V8_WARN_UNUSED_RESULT Maybe< bool > HasOwnProperty (Local< Context > context, Local< Name > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool HasRealNamedProperty(Local< String > key))
 
V8_WARN_UNUSED_RESULT Maybe< bool > HasRealNamedProperty (Local< Context > context, Local< Name > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool HasRealIndexedProperty(uint32_t index))
 
V8_WARN_UNUSED_RESULT Maybe< bool > HasRealIndexedProperty (Local< Context > context, uint32_t index)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool HasRealNamedCallbackProperty(Local< String > key))
 
V8_WARN_UNUSED_RESULT Maybe< bool > HasRealNamedCallbackProperty (Local< Context > context, Local< Name > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Value > GetRealNamedPropertyInPrototypeChain(Local< String > key))
 
V8_WARN_UNUSED_RESULT MaybeLocal< ValueGetRealNamedPropertyInPrototypeChain (Local< Context > context, Local< Name > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", Maybe< PropertyAttribute > GetRealNamedPropertyAttributesInPrototypeChain(Local< String > key))
 
V8_WARN_UNUSED_RESULT Maybe< PropertyAttribute > GetRealNamedPropertyAttributesInPrototypeChain (Local< Context > context, Local< Name > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Value > GetRealNamedProperty(Local< String > key))
 
V8_WARN_UNUSED_RESULT MaybeLocal< ValueGetRealNamedProperty (Local< Context > context, Local< Name > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", Maybe< PropertyAttribute > GetRealNamedPropertyAttributes(Local< String > key))
 
V8_WARN_UNUSED_RESULT Maybe< PropertyAttribute > GetRealNamedPropertyAttributes (Local< Context > context, Local< Name > key)
 
bool HasNamedLookupInterceptor ()
 
bool HasIndexedLookupInterceptor ()
 
int GetIdentityHash ()
 
bool SetHiddenValue (Local< String > key, Local< Value > value)
 
Local< ValueGetHiddenValue (Local< String > key)
 
bool DeleteHiddenValue (Local< String > key)
 
Local< ObjectClone ()
 
Local< ContextCreationContext ()
 
bool IsCallable ()
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Value > CallAsFunction(Local< Value > recv, int argc, Local< Value > argv[]))
 
V8_WARN_UNUSED_RESULT MaybeLocal< ValueCallAsFunction (Local< Context > context, Local< Value > recv, int argc, Local< Value > argv[])
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Value > CallAsConstructor(int argc, Local< Value > argv[]))
 
V8_WARN_UNUSED_RESULT MaybeLocal< ValueCallAsConstructor (Local< Context > context, int argc, Local< Value > argv[])
 
 V8_DEPRECATE_SOON ("Keep track of isolate correctly", Isolate *GetIsolate())
 
- Public Member Functions inherited from v8::Value
V8_INLINE bool IsUndefined () const
 
V8_INLINE bool IsNull () const
 
bool IsTrue () const
 
bool IsFalse () const
 
bool IsName () const
 
V8_INLINE bool IsString () const
 
bool IsSymbol () const
 
bool IsFunction () const
 
bool IsArray () const
 
bool IsObject () const
 
bool IsBoolean () const
 
bool IsNumber () const
 
bool IsExternal () const
 
bool IsInt32 () const
 
bool IsUint32 () const
 
bool IsDate () const
 
bool IsArgumentsObject () const
 
bool IsBooleanObject () const
 
bool IsNumberObject () const
 
bool IsStringObject () const
 
bool IsSymbolObject () const
 
bool IsNativeError () const
 
bool IsRegExp () 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 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 IsFloat32Array () const
 
bool IsFloat64Array () const
 
bool IsFloat32x4 () const
 
bool IsDataView () const
 
bool IsSharedArrayBuffer () const
 
V8_WARN_UNUSED_RESULT MaybeLocal< BooleanToBoolean (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT MaybeLocal< NumberToNumber (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT MaybeLocal< StringToString (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT MaybeLocal< StringToDetailString (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT MaybeLocal< ObjectToObject (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT MaybeLocal< IntegerToInteger (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT MaybeLocal< Uint32ToUint32 (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT MaybeLocal< Int32ToInt32 (Local< Context > context) const
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Boolean > ToBoolean(Isolate *isolate) const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Number > ToNumber(Isolate *isolate) const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< String > ToString(Isolate *isolate) const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< String > ToDetailString(Isolate *isolate) const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Object > ToObject(Isolate *isolate) const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Integer > ToInteger(Isolate *isolate) const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Uint32 > ToUint32(Isolate *isolate) const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Int32 > ToInt32(Isolate *isolate) const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Boolean > ToBoolean() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Number > ToNumber() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< String > ToString() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< String > ToDetailString() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Object > ToObject() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Integer > ToInteger() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Uint32 > ToUint32() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Int32 > ToInt32() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Uint32 > ToArrayIndex() const)
 
V8_WARN_UNUSED_RESULT MaybeLocal< Uint32ToArrayIndex (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT Maybe< bool > BooleanValue (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT Maybe< double > NumberValue (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT Maybe< int64_t > IntegerValue (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT Maybe< uint32_t > Uint32Value (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT Maybe< int32_t > Int32Value (Local< Context > context) const
 
 V8_DEPRECATE_SOON ("Use maybe version", bool BooleanValue() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", double NumberValue() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", int64_t IntegerValue() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", uint32_t Uint32Value() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", int32_t Int32Value() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool Equals(Local< Value > that) const)
 
V8_WARN_UNUSED_RESULT Maybe< bool > Equals (Local< Context > context, Local< Value > that) const
 
bool StrictEquals (Local< Value > that) const
 
bool SameValue (Local< Value > that) const
 
template<class T >
ValueCast (T *value)
 

Static Public Member Functions

static V8_INLINE int InternalFieldCount (const PersistentBase< Object > &object)
 
static V8_INLINE void * GetAlignedPointerFromInternalField (const PersistentBase< Object > &object, int index)
 
static Local< ObjectNew (Isolate *isolate)
 
static V8_INLINE ObjectCast (Value *obj)
 
- Static Public Member Functions inherited from v8::Value
template<class T >
static V8_INLINE ValueCast (T *value)
 

Detailed Description

A JavaScript object (ECMA-262, 4.3.3)

Member Function Documentation

Local<Object> v8::Object::Clone ( )

Clone this object with a fast but shallow copy. Values will point to the same values as the original object.

Local<Context> v8::Object::CreationContext ( )

Returns the context in which the object was created.

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

Finds an instance of the given function template in the prototype chain.

void * v8::Object::GetAlignedPointerFromInternalField ( int  index)

Gets a 2-byte-aligned native pointer from an internal field. This field must have been set by SetAlignedPointerInInternalField, everything else leads to undefined behavior.

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

Same as above, but works for Persistents

Local<String> v8::Object::GetConstructorName ( )

Returns the name of the function invoked as a constructor for this object.

int v8::Object::GetIdentityHash ( )

Returns the identity hash for this object. The current implementation uses a hidden property on the object to store the identity hash.

The return value will never be 0. Also, it is not guaranteed to be unique.

Local< Value > v8::Object::GetInternalField ( int  index)

Gets the value from an internal field.

Local<Value> v8::Object::GetPrototype ( )

Get the prototype object. This does not skip objects marked to be skipped by proto and it does not consult the security handler.

bool v8::Object::HasIndexedLookupInterceptor ( )

Tests for an index lookup interceptor.

bool v8::Object::HasNamedLookupInterceptor ( )

Tests for a named lookup interceptor.

int v8::Object::InternalFieldCount ( )

Gets the number of internal fields for this Object.

static V8_INLINE int v8::Object::InternalFieldCount ( const PersistentBase< Object > &  object)
inlinestatic

Same as above, but works for Persistents

bool v8::Object::IsCallable ( )

Checks whether a callback is set by the ObjectTemplate::SetCallAsFunctionHandler method. When an Object is callable this method returns true.

void v8::Object::SetAlignedPointerInInternalField ( int  index,
void *  value 
)

Sets a 2-byte-aligned native pointer in an internal field. To retrieve such a field, GetAlignedPointerFromInternalField must be used, everything else leads to undefined behavior.

bool v8::Object::SetHiddenValue ( Local< String key,
Local< Value value 
)

Access hidden properties on JavaScript objects. These properties are hidden from the executing JavaScript and only accessible through the V8 C++ API. Hidden properties introduced by V8 internally (for example the identity hash) are prefixed with "v8::".

void v8::Object::SetInternalField ( int  index,
Local< Value value 
)

Sets the value in an internal field.

v8::Object::V8_DEPRECATE_SOON ( "Use maybe version"  ,
PropertyAttribute   GetPropertyAttributesLocal< Value > key 
)

Gets the property attributes of a property which can be None or any combination of ReadOnly, DontEnum and DontDelete. Returns None when the property doesn't exist.

v8::Object::V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< Value >   GetOwnPropertyDescriptorLocal< String > key 
)

Returns Object.getOwnPropertyDescriptor as per ES5 section 15.2.3.3.

v8::Object::V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< Array >   GetPropertyNames() 
)

Returns an array containing the names of the enumerable properties of this object, including properties from prototype objects. The array returned by this method contains the same values as would be enumerated by a for-in statement over this object.

v8::Object::V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< Array >   GetOwnPropertyNames() 
)

This function has the same functionality as GetPropertyNames but the returned array doesn't contain the names of properties from prototype objects.

v8::Object::V8_DEPRECATE_SOON ( "Use maybe version"  ,
bool   SetPrototypeLocal< Value > prototype 
)

Set the prototype object. This does not skip objects marked to be skipped by proto and it does not consult the security handler.

v8::Object::V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< String >   ObjectProtoToString() 
)

Call builtin Object.prototype.toString on this object. This is different from Value::ToString() that may call user-defined toString function. This one does not.

v8::Object::V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< Value >   GetRealNamedPropertyInPrototypeChainLocal< String > key 
)

If result.IsEmpty() no real property was located in the prototype chain. This means interceptors in the prototype chain are not called.

v8::Object::V8_DEPRECATE_SOON ( "Use maybe version"  ,
Maybe< PropertyAttribute >   GetRealNamedPropertyAttributesInPrototypeChainLocal< String > key 
)

Gets the property attributes of a real property in the prototype chain, which can be None or any combination of ReadOnly, DontEnum and DontDelete. Interceptors in the prototype chain are not called.

v8::Object::V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< Value >   GetRealNamedPropertyLocal< String > key 
)

If result.IsEmpty() no real property was located on the object or in the prototype chain. This means interceptors in the prototype chain are not called.

v8::Object::V8_DEPRECATE_SOON ( "Use maybe version"  ,
Maybe< PropertyAttribute >   GetRealNamedPropertyAttributesLocal< String > key 
)

Gets the property attributes of a real property which can be None or any combination of ReadOnly, DontEnum and DontDelete. Interceptors in the prototype chain are not called.

v8::Object::V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< Value >   CallAsFunctionLocal< Value > recv, int argc, Local< Value > argv[] 
)

Call an Object as a function if a callback is set by the ObjectTemplate::SetCallAsFunctionHandler method.

v8::Object::V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< Value >   CallAsConstructorint argc, Local< Value > argv[] 
)

Call an Object as a constructor if a callback is set by the ObjectTemplate::SetCallAsFunctionHandler method. Note: This method behaves like the Function::NewInstance method.

v8::Object::V8_DEPRECATE_SOON ( "Keep track of isolate correctly"  ,
Isolate GetIsolate() 
)

Return the isolate to which the Object belongs to.


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