v8::ObjectTemplate Class Reference

#include <v8-template.h>

Inheritance diagram for v8::ObjectTemplate:

Collaboration diagram for v8::ObjectTemplate:

Public Member Functions
MaybeLocal< Object >	NewInstance (Local< Context > context)
void	SetHandler (const NamedPropertyHandlerConfiguration &configuration)
void	SetHandler (const IndexedPropertyHandlerConfiguration &configuration)
void	SetCallAsFunctionHandler (FunctionCallback callback, Local< Value > data=Local< Value >())
void	MarkAsUndetectable ()
void	SetAccessCheckCallback (AccessCheckCallback callback, Local< Value > data=Local< Value >())
void	SetAccessCheckCallbackAndHandler (AccessCheckCallback callback, const NamedPropertyHandlerConfiguration &named_handler, const IndexedPropertyHandlerConfiguration &indexed_handler, Local< Value > data=Local< Value >())
int	InternalFieldCount () const
void	SetInternalFieldCount (int value)
bool	IsImmutableProto () const
void	SetImmutableProto ()
void	SetCodeLike ()
bool	IsCodeLike () const
Public Member Functions inherited from v8::Template
void	Set (Local< Name > name, Local< Data > value, PropertyAttribute attributes=None)
void	SetPrivate (Local< Private > name, Local< Data > value, PropertyAttribute attributes=None)
void	Set (Isolate *isolate, const char *name, Local< Data > value, PropertyAttribute attributes=None)
void	SetAccessorProperty (Local< Name > name, Local< FunctionTemplate > getter=Local< FunctionTemplate >(), Local< FunctionTemplate > setter=Local< FunctionTemplate >(), PropertyAttribute attribute=None)
void	SetNativeDataProperty (Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=nullptr, Local< Value > data=Local< Value >(), PropertyAttribute attribute=None, SideEffectType getter_side_effect_type=SideEffectType::kHasSideEffect, SideEffectType setter_side_effect_type=SideEffectType::kHasSideEffect)
void	SetLazyDataProperty (Local< Name > name, AccessorNameGetterCallback getter, Local< Value > data=Local< Value >(), PropertyAttribute attribute=None, SideEffectType getter_side_effect_type=SideEffectType::kHasSideEffect, SideEffectType setter_side_effect_type=SideEffectType::kHasSideEffect)
void	SetIntrinsicDataProperty (Local< Name > name, Intrinsic intrinsic, PropertyAttribute attribute=None)
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 Local< ObjectTemplate >	New (Isolate *isolate, Local< FunctionTemplate > constructor=Local< FunctionTemplate >())
static ObjectTemplate *	Cast (Data *data)

Friends
class	FunctionTemplate

Detailed Description

An ObjectTemplate is used to create objects at runtime.

Properties added to an ObjectTemplate are added to each object created from the ObjectTemplate.

Examples

process.cc.

Member Function Documentation

Cast()

ObjectTemplate * v8::ObjectTemplate::Cast ( Data *  data )

inlinestatic

InternalFieldCount()

int v8::ObjectTemplate::InternalFieldCount

(

)

const

Gets the number of internal fields for objects generated from this template.

IsCodeLike()

bool v8::ObjectTemplate::IsCodeLike

(

)

const

IsImmutableProto()

bool v8::ObjectTemplate::IsImmutableProto

(

)

const

Returns true if the object will be an immutable prototype exotic object.

MarkAsUndetectable()

void v8::ObjectTemplate::MarkAsUndetectable

(

)

Mark object instances of the template as undetectable.

In many ways, undetectable objects behave as though they are not there. They behave like 'undefined' in conditionals and when printed. However, properties can be accessed and called as on normal objects.

New()

static Local< ObjectTemplate > v8::ObjectTemplate::New ( Isolate *  isolate, Local< FunctionTemplate >  constructor = Local< FunctionTemplate >()  )

static

Creates an ObjectTemplate.

Examples

shell.cc.

NewInstance()

MaybeLocal< Object > v8::ObjectTemplate::NewInstance

(

Local< Context >

context

)

Creates a new instance of this template.

Parameters

context

The context in which the instance is created.

SetAccessCheckCallback()

void v8::ObjectTemplate::SetAccessCheckCallback	(	AccessCheckCallback	callback,
		Local< Value >	data = Local< Value >()
	)

Sets access check callback on the object template and enables access checks.

When accessing properties on instances of this object template, the access check callback will be called to determine whether or not to allow cross-context access to the properties.

SetAccessCheckCallbackAndHandler()

void v8::ObjectTemplate::SetAccessCheckCallbackAndHandler	(	AccessCheckCallback	callback,
		const NamedPropertyHandlerConfiguration &	named_handler,
		const IndexedPropertyHandlerConfiguration &	indexed_handler,
		Local< Value >	data = Local< Value >()
	)

Like SetAccessCheckCallback but invokes an interceptor on failed access checks instead of looking up all-can-read properties. You can only use either this method or SetAccessCheckCallback, but not both at the same time.

SetCallAsFunctionHandler()

void v8::ObjectTemplate::SetCallAsFunctionHandler	(	FunctionCallback	callback,
		Local< Value >	data = Local< Value >()
	)

Sets the callback to be used when calling instances created from this template as a function. If no callback is set, instances behave like normal JavaScript objects that cannot be called as a function.

SetCodeLike()

void v8::ObjectTemplate::SetCodeLike

(

)

Support for TC39 "dynamic code brand checks" proposal.

This API allows to mark (& query) objects as "code like", which causes them to be treated like Strings in the context of eval and function constructor.

Reference: https://github.com/tc39/proposal-dynamic-code-brand-checks

SetHandler() [1/2]

void v8::ObjectTemplate::SetHandler

(

const IndexedPropertyHandlerConfiguration &

configuration

)

Sets an indexed property handler on the object template.

Whenever an indexed property is accessed on objects created from this object template, the provided callback is invoked instead of accessing the property directly on the JavaScript object.

Parameters

configuration

The IndexedPropertyHandlerConfiguration that defines the callbacks to invoke when accessing a property.

SetHandler() [2/2]

void v8::ObjectTemplate::SetHandler

(

const NamedPropertyHandlerConfiguration &

configuration

)

Sets a named property handler on the object template.

Whenever a property whose name is a string or a symbol is accessed on objects created from this object template, the provided callback is invoked instead of accessing the property directly on the JavaScript object.

Parameters

configuration

The NamedPropertyHandlerConfiguration that defines the callbacks to invoke when accessing a property.

SetImmutableProto()

void v8::ObjectTemplate::SetImmutableProto

(

)

Makes the ObjectTemplate for an immutable prototype exotic object, with an immutable proto.

SetInternalFieldCount()

void v8::ObjectTemplate::SetInternalFieldCount

(

int

value

)

Sets the number of internal fields for objects generated from this template.

Friends And Related Function Documentation

FunctionTemplate

friend class FunctionTemplate

friend

---

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

• include/v8-template.h