V8 API Reference, 7.2.502.16 (for Deno 0.2.4)
v8::Object Class Reference

#include <v8.h>

Inheritance diagram for v8::Object:
v8::Value v8::Data v8::Array v8::ArrayBuffer v8::ArrayBufferView v8::BigIntObject v8::BooleanObject v8::Date v8::debug::WeakMap v8::Function v8::Map v8::NumberObject v8::Promise v8::Promise::Resolver v8::Proxy v8::RegExp v8::Set v8::SharedArrayBuffer v8::StringObject v8::SymbolObject v8::WasmCompiledModule

Public Member Functions

 V8_DEPRECATE_SOON ("Use maybe version", bool Set(Local< Value > key, Local< Value > value))
 
V8_WARN_UNUSED_RESULT Maybe< boolSet (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< boolSet (Local< Context > context, uint32_t index, Local< Value > value)
 
V8_WARN_UNUSED_RESULT Maybe< boolCreateDataProperty (Local< Context > context, Local< Name > key, Local< Value > value)
 
V8_WARN_UNUSED_RESULT Maybe< boolCreateDataProperty (Local< Context > context, uint32_t index, Local< Value > value)
 
V8_WARN_UNUSED_RESULT Maybe< boolDefineOwnProperty (Local< Context > context, Local< Name > key, Local< Value > value, PropertyAttribute attributes=None)
 
V8_WARN_UNUSED_RESULT Maybe< boolDefineProperty (Local< Context > context, Local< Name > key, PropertyDescriptor &descriptor)
 
 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_WARN_UNUSED_RESULT Maybe< PropertyAttributeGetPropertyAttributes (Local< Context > context, Local< Value > key)
 
V8_WARN_UNUSED_RESULT MaybeLocal< ValueGetOwnPropertyDescriptor (Local< Context > context, Local< Name > key)
 
 V8_DEPRECATED ("Use maybe version", bool Has(Local< Value > key))
 
V8_WARN_UNUSED_RESULT Maybe< boolHas (Local< Context > context, Local< Value > key)
 
 V8_DEPRECATED ("Use maybe version", bool Delete(Local< Value > key))
 
V8_WARN_UNUSED_RESULT Maybe< boolDelete (Local< Context > context, Local< Value > key)
 
V8_WARN_UNUSED_RESULT Maybe< boolHas (Local< Context > context, uint32_t index)
 
V8_WARN_UNUSED_RESULT Maybe< boolDelete (Local< Context > context, uint32_t index)
 
V8_WARN_UNUSED_RESULT Maybe< boolSetAccessor (Local< Context > context, Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=nullptr, MaybeLocal< Value > data=MaybeLocal< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None, SideEffectType getter_side_effect_type=SideEffectType::kHasSideEffect, SideEffectType setter_side_effect_type=SideEffectType::kHasSideEffect)
 
void SetAccessorProperty (Local< Name > name, Local< Function > getter, Local< Function > setter=Local< Function >(), PropertyAttribute attribute=None, AccessControl settings=DEFAULT)
 
V8_WARN_UNUSED_RESULT Maybe< boolSetNativeDataProperty (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)
 
V8_WARN_UNUSED_RESULT Maybe< boolSetLazyDataProperty (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< boolHasPrivate (Local< Context > context, Local< Private > key)
 
Maybe< boolSetPrivate (Local< Context > context, Local< Private > key, Local< Value > value)
 
Maybe< boolDeletePrivate (Local< Context > context, Local< Private > key)
 
MaybeLocal< ValueGetPrivate (Local< Context > context, Local< Private > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Array > GetPropertyNames())
 
V8_WARN_UNUSED_RESULT MaybeLocal< ArrayGetPropertyNames (Local< Context > context)
 
V8_WARN_UNUSED_RESULT MaybeLocal< ArrayGetPropertyNames (Local< Context > context, KeyCollectionMode mode, PropertyFilter property_filter, IndexFilter index_filter, KeyConversionMode key_conversion=KeyConversionMode::kKeepNumbers)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Array > GetOwnPropertyNames())
 
V8_WARN_UNUSED_RESULT MaybeLocal< ArrayGetOwnPropertyNames (Local< Context > context)
 
V8_WARN_UNUSED_RESULT MaybeLocal< ArrayGetOwnPropertyNames (Local< Context > context, PropertyFilter filter, KeyConversionMode key_conversion=KeyConversionMode::kKeepNumbers)
 
Local< ValueGetPrototype ()
 
V8_WARN_UNUSED_RESULT Maybe< boolSetPrototype (Local< Context > context, Local< Value > prototype)
 
Local< ObjectFindInstanceInPrototypeChain (Local< FunctionTemplate > tmpl)
 
V8_WARN_UNUSED_RESULT MaybeLocal< StringObjectProtoToString (Local< Context > context)
 
Local< StringGetConstructorName ()
 
Maybe< boolSetIntegrityLevel (Local< Context > context, IntegrityLevel level)
 
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)
 
void SetAlignedPointerInInternalFields (int argc, int indices[], void *values[])
 
V8_WARN_UNUSED_RESULT Maybe< boolHasOwnProperty (Local< Context > context, Local< Name > key)
 
V8_WARN_UNUSED_RESULT Maybe< boolHasOwnProperty (Local< Context > context, uint32_t index)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool HasRealNamedProperty(Local< String > key))
 
V8_WARN_UNUSED_RESULT Maybe< boolHasRealNamedProperty (Local< Context > context, Local< Name > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool HasRealIndexedProperty(uint32_t index))
 
V8_WARN_UNUSED_RESULT Maybe< boolHasRealIndexedProperty (Local< Context > context, uint32_t index)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool HasRealNamedCallbackProperty(Local< String > key))
 
V8_WARN_UNUSED_RESULT Maybe< boolHasRealNamedCallbackProperty (Local< Context > context, Local< Name > key)
 
V8_WARN_UNUSED_RESULT MaybeLocal< ValueGetRealNamedPropertyInPrototypeChain (Local< Context > context, Local< Name > key)
 
V8_WARN_UNUSED_RESULT Maybe< PropertyAttributeGetRealNamedPropertyAttributesInPrototypeChain (Local< Context > context, Local< Name > key)
 
V8_WARN_UNUSED_RESULT MaybeLocal< ValueGetRealNamedProperty (Local< Context > context, Local< Name > key)
 
V8_WARN_UNUSED_RESULT Maybe< PropertyAttributeGetRealNamedPropertyAttributes (Local< Context > context, Local< Name > key)
 
bool HasNamedLookupInterceptor ()
 
bool HasIndexedLookupInterceptor ()
 
int GetIdentityHash ()
 
Local< ObjectClone ()
 
Local< Context > CreationContext ()
 
bool IsCallable ()
 
bool IsConstructor ()
 
V8_WARN_UNUSED_RESULT MaybeLocal< ValueCallAsFunction (Local< Context > context, Local< Value > recv, int argc, Local< Value > argv[])
 
V8_WARN_UNUSED_RESULT MaybeLocal< ValueCallAsConstructor (Local< Context > context, int argc, Local< Value > argv[])
 
Isolate * GetIsolate ()
 
MaybeLocal< ArrayPreviewEntries (bool *is_key_value)
 
- Public Member Functions inherited from v8::Value
V8_INLINE bool IsUndefined () const
 
V8_INLINE bool IsNull () const
 
V8_INLINE bool IsNullOrUndefined () 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 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 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 IsBigInt64Array () const
 
bool IsBigUint64Array () const
 
bool IsDataView () const
 
bool IsSharedArrayBuffer () const
 
bool IsProxy () const
 
bool IsWebAssemblyCompiledModule () const
 
bool IsModuleNamespaceObject () const
 
V8_WARN_UNUSED_RESULT MaybeLocal< BigIntToBigInt (Local< Context > context) const
 
 V8_DEPRECATE_SOON ("ToBoolean can never throw. Use Local version.", V8_WARN_UNUSED_RESULT MaybeLocal< Boolean > ToBoolean(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
 
Local< BooleanToBoolean (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< Object > ToObject(Isolate *isolate) const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Integer > ToInteger(Isolate *isolate) const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Int32 > ToInt32(Isolate *isolate) const)
 
V8_WARN_UNUSED_RESULT MaybeLocal< Uint32ToArrayIndex (Local< Context > context) const
 
bool BooleanValue (Isolate *isolate) const
 
 V8_DEPRECATE_SOON ("BooleanValue can never throw. Use Isolate version.", 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_tIntegerValue (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT Maybe< uint32_tUint32Value (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT Maybe< int32_t > Int32Value (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT Maybe< boolEquals (Local< Context > context, Local< Value > that) const
 
bool StrictEquals (Local< Value > that) const
 
bool SameValue (Local< Value > that) const
 
Local< StringTypeOf (Isolate *)
 
Maybe< boolInstanceOf (Local< Context > context, Local< Object > object)
 

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 V8_INLINE Local< Context > CreationContext (const PersistentBase< Object > &object)
 
static Local< ObjectNew (Isolate *isolate)
 
static Local< ObjectNew (Isolate *isolate, Local< Value > prototype_or_null, Local< Name > *names, Local< Value > *values, size_t length)
 
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)

Definition at line 3239 of file v8.h.

Member Function Documentation

◆ CallAsConstructor()

MaybeLocal< Value > v8::Object::CallAsConstructor ( Local< Context >  context,
int  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.

Definition at line 4902 of file api.cc.

◆ CallAsFunction()

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

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

Definition at line 4882 of file api.cc.

◆ Clone()

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

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

Definition at line 4847 of file api.cc.

◆ CreationContext() [1/2]

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

Returns the context in which the object was created.

Definition at line 4857 of file api.cc.

◆ CreationContext() [2/2]

static V8_INLINE Local<Context> v8::Object::CreationContext ( const PersistentBase< Object > &  object)
inlinestatic

Same as above, but works for Persistents

Definition at line 3601 of file v8.h.

◆ FindInstanceInPrototypeChain()

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

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

Definition at line 4367 of file api.cc.

◆ GetAlignedPointerFromInternalField() [1/2]

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.

Definition at line 9887 of file v8.h.

◆ GetAlignedPointerFromInternalField() [2/2]

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

Same as above, but works for Persistents

Definition at line 3492 of file v8.h.

◆ GetConstructorName()

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

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

Definition at line 4447 of file api.cc.

◆ GetIdentityHash()

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.

Definition at line 4863 of file api.cc.

◆ GetInternalField()

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

Gets the value from an internal field.

Definition at line 9865 of file v8.h.

◆ GetIsolate()

Isolate * v8::Object::GetIsolate ( )

Return the isolate to which the Object belongs to.

Definition at line 6700 of file api.cc.

◆ GetOwnPropertyDescriptor()

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

Returns Object.getOwnPropertyDescriptor as per ES2016 section 19.1.2.6.

Definition at line 4323 of file api.cc.

◆ GetOwnPropertyNames()

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

Returns an array containing the names of the filtered 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.

Definition at line 4427 of file api.cc.

◆ GetPropertyAttributes()

Maybe< PropertyAttribute > v8::Object::GetPropertyAttributes ( Local< Context >  context,
Local< 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.

Definition at line 4300 of file api.cc.

◆ GetPrototype()

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.

Definition at line 4341 of file api.cc.

◆ GetRealNamedProperty()

MaybeLocal< Value > v8::Object::GetRealNamedProperty ( Local< Context >  context,
Local< Name 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.

Definition at line 4810 of file api.cc.

◆ GetRealNamedPropertyAttributes()

Maybe< PropertyAttribute > v8::Object::GetRealNamedPropertyAttributes ( Local< Context >  context,
Local< Name 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.

Definition at line 4826 of file api.cc.

◆ GetRealNamedPropertyAttributesInPrototypeChain()

Maybe< PropertyAttribute > v8::Object::GetRealNamedPropertyAttributesInPrototypeChain ( Local< Context >  context,
Local< Name 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.

Definition at line 4785 of file api.cc.

◆ GetRealNamedPropertyInPrototypeChain()

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

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

Definition at line 4762 of file api.cc.

◆ Has()

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

Object::Has() calls the abstract operation HasProperty(O, P) described in ECMA-262, 7.3.10. Has() returns true, if the object has the property, either own or on the prototype chain. Interceptors, i.e., PropertyQueryCallbacks, are called if present.

Has() has the same side effects as JavaScript's variable in object. For example, calling Has() on a revoked proxy will throw an exception.

Note
Has() converts the key to a name, which possibly calls back into JavaScript.

See also v8::Object::HasOwnProperty() and v8::Object::HasRealNamedProperty().

Definition at line 4513 of file api.cc.

◆ HasIndexedLookupInterceptor()

bool v8::Object::HasIndexedLookupInterceptor ( )

Tests for an index lookup interceptor.

Definition at line 4755 of file api.cc.

◆ HasNamedLookupInterceptor()

bool v8::Object::HasNamedLookupInterceptor ( )

Tests for a named lookup interceptor.

Definition at line 4748 of file api.cc.

◆ HasOwnProperty()

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

HasOwnProperty() is like JavaScript's Object.prototype.hasOwnProperty().

See also v8::Object::Has() and v8::Object::HasRealNamedProperty().

Definition at line 4659 of file api.cc.

◆ HasPrivate()

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

Functionality for private properties. This is an experimental feature, use at your own risk. Note: Private properties are not inherited. Do not rely on this, since it may change.

Definition at line 4542 of file api.cc.

◆ HasRealNamedProperty()

bool v8::Object::HasRealNamedProperty ( Local< Context >  context,
Local< Name key 
)

Use HasRealNamedProperty() if you want to check if an object has an own property without causing side effects, i.e., without calling interceptors.

This function is similar to v8::Object::HasOwnProperty(), but it does not call interceptors.

Note
Consider using non-masking interceptors, i.e., the interceptors are not called if the receiver has the real named property. See v8::PropertyHandlerFlags::kNonMasking.

See also v8::Object::Has().

Definition at line 4683 of file api.cc.

◆ InternalFieldCount() [1/2]

int v8::Object::InternalFieldCount ( )

Gets the number of internal fields for this Object.

Definition at line 5784 of file api.cc.

◆ InternalFieldCount() [2/2]

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

Same as above, but works for Persistents

Definition at line 3473 of file v8.h.

◆ IsCallable()

bool v8::Object::IsCallable ( )

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

Definition at line 4872 of file api.cc.

◆ IsConstructor()

bool v8::Object::IsConstructor ( )

True if this object is a constructor.

Definition at line 4877 of file api.cc.

◆ New()

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

Creates a JavaScript object with the given properties, and a the given prototype_or_null (which can be any JavaScript value, and if it's null, the newly created object won't have a prototype at all). This is similar to Object.create(). All properties will be created as enumerable, configurable and writable properties.

Definition at line 6715 of file api.cc.

◆ ObjectProtoToString()

MaybeLocal< String > v8::Object::ObjectProtoToString ( Local< Context >  context)

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.

Definition at line 4434 of file api.cc.

◆ PreviewEntries()

v8::MaybeLocal< v8::Array > v8::Object::PreviewEntries ( bool is_key_value)

If this object is a Set, Map, WeakSet or WeakMap, this returns a representation of the elements of this object as an array. If this object is a SetIterator or MapIterator, this returns all elements of the underlying collection, starting at the iterator's current position. For other types, this will return an empty MaybeLocal<Array> (without scheduling an exception).

Definition at line 9597 of file api.cc.

◆ SetAccessor()

Maybe< bool > v8::Object::SetAccessor ( Local< Context >  context,
Local< Name name,
AccessorNameGetterCallback  getter,
AccessorNameSetterCallback  setter = nullptr,
MaybeLocal< Value data = MaybeLocal<Value>(),
AccessControl  settings = DEFAULT,
PropertyAttribute  attribute = None,
SideEffectType  getter_side_effect_type = SideEffectType::kHasSideEffect,
SideEffectType  setter_side_effect_type = SideEffectType::kHasSideEffect 
)

Note: SideEffectType affects the getter only, not the setter.

Definition at line 4604 of file api.cc.

◆ SetAlignedPointerInInternalField()

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.

Definition at line 5826 of file api.cc.

◆ SetIntegrityLevel()

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

Sets the integrity level of the object.

Definition at line 4453 of file api.cc.

◆ SetInternalField()

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

Sets the value in an internal field.

Definition at line 5807 of file api.cc.

◆ SetLazyDataProperty()

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

Attempts to create a property with the given name which behaves like a data property, except that the provided getter is invoked (and provided with the data value) to supply its value the first time it is read. After the property is accessed once, it is replaced with an ordinary data property.

Analogous to Template::SetLazyDataProperty.

Definition at line 4648 of file api.cc.

◆ SetNativeDataProperty()

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

Sets a native data property like Template::SetNativeDataProperty, but this method sets on this object directly.

Definition at line 4637 of file api.cc.

◆ SetPrototype()

Maybe< bool > v8::Object::SetPrototype ( Local< Context >  context,
Local< 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.

Definition at line 4349 of file api.cc.

◆ V8_DEPRECATE_SOON() [1/2]

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_DEPRECATE_SOON() [2/2]

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.


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