Object Class Reference

#include <v8.h>

Inheritance diagram for Object:

Collaboration diagram for Object:

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_WARN_UNUSED_RESULT Maybe< bool >	DefineProperty (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< Value >	Get (Local< Context > context, Local< Value > key)
	V8_DEPRECATE_SOON ("Use maybe version", Local< Value > Get(uint32_t index))
V8_WARN_UNUSED_RESULT MaybeLocal< Value >	Get (Local< Context > context, uint32_t index)
V8_WARN_UNUSED_RESULT Maybe< PropertyAttribute >	GetPropertyAttributes (Local< Context > context, Local< Value > key)
V8_WARN_UNUSED_RESULT MaybeLocal< Value >	GetOwnPropertyDescriptor (Local< Context > context, Local< Name > 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))
V8_WARN_UNUSED_RESULT Maybe< bool >	Delete (Local< Context > context, Local< Value > key)
V8_WARN_UNUSED_RESULT Maybe< bool >	Has (Local< Context > context, uint32_t index)
V8_WARN_UNUSED_RESULT Maybe< bool >	Delete (Local< Context > context, uint32_t index)
V8_WARN_UNUSED_RESULT 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, SideEffectType getter_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< 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)
V8_WARN_UNUSED_RESULT 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)
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)
	V8_DEPRECATE_SOON ("Use maybe version", Local< Array > GetPropertyNames())
V8_WARN_UNUSED_RESULT MaybeLocal< Array >	GetPropertyNames (Local< Context > context)
V8_WARN_UNUSED_RESULT MaybeLocal< Array >	GetPropertyNames (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< Array >	GetOwnPropertyNames (Local< Context > context)
V8_WARN_UNUSED_RESULT MaybeLocal< Array >	GetOwnPropertyNames (Local< Context > context, PropertyFilter filter, KeyConversionMode key_conversion=KeyConversionMode::kKeepNumbers)
Local< Value >	GetPrototype ()
V8_WARN_UNUSED_RESULT Maybe< bool >	SetPrototype (Local< Context > context, Local< Value > prototype)
Local< Object >	FindInstanceInPrototypeChain (Local< FunctionTemplate > tmpl)
V8_WARN_UNUSED_RESULT MaybeLocal< String >	ObjectProtoToString (Local< Context > context)
Local< String >	GetConstructorName ()
Maybe< bool >	SetIntegrityLevel (Local< Context > context, IntegrityLevel level)
int	InternalFieldCount ()
V8_INLINE Local< Value >	GetInternalField (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< bool >	HasOwnProperty (Local< Context > context, Local< Name > key)
V8_WARN_UNUSED_RESULT Maybe< bool >	HasOwnProperty (Local< Context > context, uint32_t index)
	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_WARN_UNUSED_RESULT MaybeLocal< Value >	GetRealNamedPropertyInPrototypeChain (Local< Context > context, Local< Name > key)
V8_WARN_UNUSED_RESULT Maybe< PropertyAttribute >	GetRealNamedPropertyAttributesInPrototypeChain (Local< Context > context, Local< Name > key)
V8_WARN_UNUSED_RESULT MaybeLocal< Value >	GetRealNamedProperty (Local< Context > context, Local< Name > key)
V8_WARN_UNUSED_RESULT Maybe< PropertyAttribute >	GetRealNamedPropertyAttributes (Local< Context > context, Local< Name > key)
bool	HasNamedLookupInterceptor ()
bool	HasIndexedLookupInterceptor ()
int	GetIdentityHash ()
Local< Object >	Clone ()
Local< Context >	CreationContext ()
bool	IsCallable ()
bool	IsConstructor ()
V8_WARN_UNUSED_RESULT MaybeLocal< Value >	CallAsFunction (Local< Context > context, Local< Value > recv, int argc, Local< Value > argv[])
V8_WARN_UNUSED_RESULT MaybeLocal< Value >	CallAsConstructor (Local< Context > context, int argc, Local< Value > argv[])
Isolate *	GetIsolate ()
MaybeLocal< Array >	PreviewEntries (bool *is_key_value)
Public Member Functions inherited from 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< BigInt >	ToBigInt (Local< Context > context) const
V8_WARN_UNUSED_RESULT MaybeLocal< Boolean >	ToBoolean (Local< Context > context) const
V8_WARN_UNUSED_RESULT MaybeLocal< Number >	ToNumber (Local< Context > context) const
V8_WARN_UNUSED_RESULT MaybeLocal< String >	ToString (Local< Context > context) const
V8_WARN_UNUSED_RESULT MaybeLocal< String >	ToDetailString (Local< Context > context) const
V8_WARN_UNUSED_RESULT MaybeLocal< Object >	ToObject (Local< Context > context) const
V8_WARN_UNUSED_RESULT MaybeLocal< Integer >	ToInteger (Local< Context > context) const
V8_WARN_UNUSED_RESULT MaybeLocal< Uint32 >	ToUint32 (Local< Context > context) const
V8_WARN_UNUSED_RESULT MaybeLocal< Int32 >	ToInt32 (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< 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< Uint32 >	ToArrayIndex (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_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
Local< String >	TypeOf (Isolate *)
Maybe< bool >	InstanceOf (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< Object >	New (Isolate *isolate)
static V8_INLINE Object *	Cast (Value *obj)
Static Public Member Functions inherited from Value
template<class T >
static V8_INLINE Value *	Cast (T *value)

Detailed Description

A JavaScript object (ECMA-262, 4.3.3)

Definition at line 3310 of file v8.h.

Member Function Documentation

CallAsConstructor()

V8_WARN_UNUSED_RESULT MaybeLocal<Value> 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.

CallAsFunction()

V8_WARN_UNUSED_RESULT MaybeLocal<Value> 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.

Cast()

Object * Cast ( v8::Value *  value )

static

Definition at line 10343 of file v8.h.

Clone()

Local<Object> Clone

(

)

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

CreateDataProperty() [1/2]

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

CreateDataProperty() [2/2]

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

CreationContext() [1/2]

Local<Context> CreationContext

(

)

Returns the context in which the object was created.

Referenced by Object::CreationContext().

CreationContext() [2/2]

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

inlinestatic

Same as above, but works for Persistents

Definition at line 3668 of file v8.h.

References Object::CreationContext().

DefineOwnProperty()

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

DefineProperty()

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

Delete() [1/2]

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

Delete() [2/2]

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

DeletePrivate()

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

FindInstanceInPrototypeChain()

Local<Object> FindInstanceInPrototypeChain

(

Local< FunctionTemplate >

tmpl

)

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

Get() [1/2]

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

Get() [2/2]

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

GetAlignedPointerFromInternalField() [1/2]

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

inlinestatic

Same as above, but works for Persistents

Definition at line 3559 of file v8.h.

References Object::GetAlignedPointerFromInternalField().

GetAlignedPointerFromInternalField() [2/2]

void * 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 10068 of file v8.h.

References Internals::GetInstanceType(), v8::internal::kApiPointerSize, Internals::kJSApiObjectType, Internals::kJSObjectHeaderSize, Internals::kJSObjectType, Internals::kJSSpecialApiObjectType, and Internals::ReadField().

Referenced by Object::GetAlignedPointerFromInternalField().

GetConstructorName()

Local<String> GetConstructorName

(

)

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

GetIdentityHash()

int 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.

GetInternalField()

Local< Value > GetInternalField

(

int

index

)

Gets the value from an internal field.

Definition at line 10046 of file v8.h.

References Internals::GetInstanceType(), v8::internal::kApiPointerSize, Internals::kJSApiObjectType, Internals::kJSObjectHeaderSize, Internals::kJSObjectType, Internals::kJSSpecialApiObjectType, Local< T >::Local, and Internals::ReadField().

GetIsolate()

Isolate* GetIsolate

(

)

Return the isolate to which the Object belongs to.

GetOwnPropertyDescriptor()

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

Returns Object.getOwnPropertyDescriptor as per ES2016 section 19.1.2.6.

GetOwnPropertyNames() [1/2]

V8_WARN_UNUSED_RESULT MaybeLocal<Array> GetOwnPropertyNames

(

Local< Context >

context

)

GetOwnPropertyNames() [2/2]

V8_WARN_UNUSED_RESULT MaybeLocal<Array> 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.

GetPrivate()

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

GetPropertyAttributes()

V8_WARN_UNUSED_RESULT Maybe<PropertyAttribute> 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.

GetPropertyNames() [1/2]

V8_WARN_UNUSED_RESULT MaybeLocal<Array> GetPropertyNames

(

Local< Context >

context

)

GetPropertyNames() [2/2]

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

GetPrototype()

Local<Value> GetPrototype

(

)

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

GetRealNamedProperty()

V8_WARN_UNUSED_RESULT MaybeLocal<Value> 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.

GetRealNamedPropertyAttributes()

V8_WARN_UNUSED_RESULT Maybe<PropertyAttribute> 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.

GetRealNamedPropertyAttributesInPrototypeChain()

V8_WARN_UNUSED_RESULT Maybe<PropertyAttribute> 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.

GetRealNamedPropertyInPrototypeChain()

V8_WARN_UNUSED_RESULT MaybeLocal<Value> 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.

Has() [1/2]

V8_WARN_UNUSED_RESULT Maybe<bool> 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().

Has() [2/2]

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

HasIndexedLookupInterceptor()

bool HasIndexedLookupInterceptor

(

)

Tests for an index lookup interceptor.

HasNamedLookupInterceptor()

bool HasNamedLookupInterceptor

(

)

Tests for a named lookup interceptor.

HasOwnProperty() [1/2]

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

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

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

HasOwnProperty() [2/2]

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

HasPrivate()

Maybe<bool> 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.

HasRealIndexedProperty()

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

HasRealNamedCallbackProperty()

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

HasRealNamedProperty()

V8_WARN_UNUSED_RESULT Maybe<bool> 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().

InternalFieldCount() [1/2]

int InternalFieldCount

(

)

Gets the number of internal fields for this Object.

Referenced by Object::InternalFieldCount().

InternalFieldCount() [2/2]

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

inlinestatic

Same as above, but works for Persistents

Definition at line 3540 of file v8.h.

References Object::InternalFieldCount().

IsCallable()

bool IsCallable

(

)

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

IsConstructor()

bool IsConstructor

(

)

True if this object is a constructor.

New()

static Local<Object> New ( Isolate *  isolate )

static

ObjectProtoToString()

V8_WARN_UNUSED_RESULT MaybeLocal<String> 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.

PreviewEntries()

MaybeLocal<Array> 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).

Set() [1/2]

V8_WARN_UNUSED_RESULT Maybe<bool> Set	(	Local< Context >	context,
		Local< Value >	key,
		Local< Value >	value
	)

Set() [2/2]

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

SetAccessor()

V8_WARN_UNUSED_RESULT 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,
		SideEffectType	getter_side_effect_type = SideEffectType::kHasSideEffect
	)

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

SetAccessorProperty()

void SetAccessorProperty	(	Local< Name >	name,
		Local< Function >	getter,
		Local< Function >	setter = Local< Function >(),
		PropertyAttribute	attribute = None,
		AccessControl	settings = DEFAULT
	)

SetAlignedPointerInInternalField()

void 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.

SetAlignedPointerInInternalFields()

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

SetIntegrityLevel()

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

Sets the integrity level of the object.

SetInternalField()

void SetInternalField	(	int	index,
		Local< Value >	value
	)

Sets the value in an internal field.

SetLazyDataProperty()

V8_WARN_UNUSED_RESULT 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
	)

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.

SetNativeDataProperty()

V8_WARN_UNUSED_RESULT 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
	)

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

SetPrivate()

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

SetPrototype()

V8_WARN_UNUSED_RESULT Maybe<bool> 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.

V8_DEPRECATE_SOON() [1/11]

V8_DEPRECATE_SOON	(	"Use maybe version"	,
		bool	DeleteLocal< Value > key
	)

V8_DEPRECATE_SOON() [2/11]

V8_DEPRECATE_SOON	(	"Use maybe version"	,
		bool	HasLocal< Value > key
	)

V8_DEPRECATE_SOON() [3/11]

V8_DEPRECATE_SOON	(	"Use maybe version"	,
		bool	HasRealIndexedPropertyuint32_t index
	)

V8_DEPRECATE_SOON() [4/11]

V8_DEPRECATE_SOON	(	"Use maybe version"	,
		bool	HasRealNamedCallbackPropertyLocal< String > key
	)

V8_DEPRECATE_SOON() [5/11]

V8_DEPRECATE_SOON	(	"Use maybe version"	,
		bool	HasRealNamedPropertyLocal< String > key
	)

V8_DEPRECATE_SOON() [6/11]

V8_DEPRECATE_SOON	(	"Use maybe version"	,
		bool	SetLocal< Value > key, Local< Value > value
	)

V8_DEPRECATE_SOON() [7/11]

V8_DEPRECATE_SOON	(	"Use maybe version"	,
		bool	Setuint32_t index, Local< Value > value
	)

V8_DEPRECATE_SOON() [8/11]

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

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() [10/11]

V8_DEPRECATE_SOON	(	"Use maybe version"	,
		Local< Value >	GetLocal< Value > key
	)

V8_DEPRECATE_SOON() [11/11]

V8_DEPRECATE_SOON	(	"Use maybe version"	,
		Local< Value >	Getuint32_t index
	)

---

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

• include/v8.h