v8 Namespace Reference

Data Structures
class	AccessorSignature
class	ActivityControl
class	AlignOfHelper
class	AllocationProfile
class	Array
class	ArrayBuffer
class	ArrayBufferView
class	BigInt
class	BigInt64Array
class	BigIntObject
class	BigUint64Array
class	Boolean
class	BooleanObject
class	CodeEvent
class	CodeEventHandler
class	ConvertableToTraceFormat
struct	CopyablePersistentTraits
class	CpuProfile
struct	CpuProfileDeoptFrame
struct	CpuProfileDeoptInfo
class	CpuProfileNode
class	CpuProfiler
class	Data
class	DataView
class	Date
class	DefaultGlobalMapTraits
class	DefaultPersistentValueMapTraits
class	DefaultPersistentValueVectorTraits
class	EmbedderGraph
class	EscapableHandleScope
class	Eternal
class	External
class	Float32Array
class	Float64Array
class	Function
class	FunctionCallbackInfo
class	FunctionTemplate
class	Global
class	GlobalValueMap
class	HandleScope
class	HeapGraphEdge
class	HeapGraphNode
class	HeapProfiler
class	HeapSnapshot
struct	HeapStatsUpdate
class	IdleTask
struct	IndexedPropertyHandlerConfiguration
class	Int16Array
class	Int32
class	Int32Array
class	Int8Array
class	Integer
class	JSON
class	Local
class	Location
class	Map
class	Maybe
class	MaybeLocal
class	Message
class	Module
class	Name
struct	NamedPropertyHandlerConfiguration
class	NonCopyablePersistentTraits
class	Number
class	NumberObject
class	Object
class	ObjectTemplate
class	OutputStream
class	PageAllocator
class	Persistent
class	PersistentBase
class	PersistentValueMap
class	PersistentValueMapBase
class	PersistentValueVector
class	Platform
class	Primitive
class	PrimitiveArray
class	Private
class	Promise
class	PropertyCallbackInfo
class	PropertyDescriptor
class	Proxy
class	RegExp
struct	RegisterState
class	RetainedObjectInfo
class	ReturnValue
struct	SampleInfo
class	Script
class	ScriptCompiler
class	ScriptOrigin
class	ScriptOriginOptions
class	ScriptOrModule
class	SealHandleScope
class	Set
class	SharedArrayBuffer
class	Signature
class	StackFrame
class	StackTrace
class	StdGlobalValueMap
class	StdMapTraits
class	StdPersistentValueMap
class	String
class	StringObject
class	Symbol
class	SymbolObject
class	Task
class	TaskRunner
class	Template
class	Testing
struct	TickSample
class	TracingController
class	TypedArray
class	Uint16Array
class	Uint32
class	Uint32Array
class	Uint8Array
class	Uint8ClampedArray
class	UnboundModuleScript
class	UnboundScript
class	Value
class	ValueDeserializer
class	ValueSerializer
class	WasmCompiledModule
class	WasmModuleObjectBuilderStreaming
class	WasmStreaming
class	WeakCallbackInfo
class	WeakCallbackObject

Typedefs
typedef uint32_t	SnapshotObjectId
typedef uintptr_t	PersistentContainerValue
template<class T >
using	Handle = Local< T >
template<class T >
using	UniquePersistent = Global< T >
typedef void(*	AccessorGetterCallback) (Local< String > property, const PropertyCallbackInfo< Value > &info)
typedef void(*	AccessorNameGetterCallback) (Local< Name > property, const PropertyCallbackInfo< Value > &info)
typedef void(*	AccessorSetterCallback) (Local< String > property, Local< Value > value, const PropertyCallbackInfo< void > &info)
typedef void(*	AccessorNameSetterCallback) (Local< Name > property, Local< Value > value, const PropertyCallbackInfo< void > &info)
typedef void(*	FunctionCallback) (const FunctionCallbackInfo< Value > &info)
typedef void(*	GenericNamedPropertyGetterCallback) (Local< Name > property, const PropertyCallbackInfo< Value > &info)
typedef void(*	GenericNamedPropertySetterCallback) (Local< Name > property, Local< Value > value, const PropertyCallbackInfo< Value > &info)
typedef void(*	GenericNamedPropertyQueryCallback) (Local< Name > property, const PropertyCallbackInfo< Integer > &info)
typedef void(*	GenericNamedPropertyDeleterCallback) (Local< Name > property, const PropertyCallbackInfo< Boolean > &info)
typedef void(*	GenericNamedPropertyEnumeratorCallback) (const PropertyCallbackInfo< Array > &info)
typedef void(*	GenericNamedPropertyDefinerCallback) (Local< Name > property, const PropertyDescriptor &desc, const PropertyCallbackInfo< Value > &info)
typedef void(*	GenericNamedPropertyDescriptorCallback) (Local< Name > property, const PropertyCallbackInfo< Value > &info)
typedef void(*	IndexedPropertyGetterCallback) (uint32_t index, const PropertyCallbackInfo< Value > &info)
typedef void(*	IndexedPropertySetterCallback) (uint32_t index, Local< Value > value, const PropertyCallbackInfo< Value > &info)
typedef void(*	IndexedPropertyQueryCallback) (uint32_t index, const PropertyCallbackInfo< Integer > &info)
typedef void(*	IndexedPropertyDeleterCallback) (uint32_t index, const PropertyCallbackInfo< Boolean > &info)
typedef void(*	IndexedPropertyEnumeratorCallback) (const PropertyCallbackInfo< Array > &info)
typedef void(*	IndexedPropertyDefinerCallback) (uint32_t index, const PropertyDescriptor &desc, const PropertyCallbackInfo< Value > &info)
typedef void(*	IndexedPropertyDescriptorCallback) (uint32_t index, const PropertyCallbackInfo< Value > &info)
typedef bool(*	AccessCheckCallback) (Local< Context > accessing_context, Local< Object > accessed_object, Local< Value > data)

Enumerations
enum	CpuProfilingMode { kLeafNodeLineNumbers, kCallerLineNumbers }
enum	CodeEventType { kUnknownType }
enum	PersistentContainerCallbackType { kNotWeak, kWeakWithParameter, kWeakWithInternalFields, kWeak = kWeakWithParameter }
enum	WeakCallbackType { kParameter, kInternalFields, kFinalizer }
enum	StateTag {   JS, GC, PARSER, BYTECODE_COMPILER,   COMPILER, OTHER, EXTERNAL, IDLE }
enum	NewStringType { NewStringType::kNormal, NewStringType::kInternalized }
enum	PropertyAttribute { None = 0, ReadOnly = 1 << 0, DontEnum = 1 << 1, DontDelete = 1 << 2 }
enum	AccessControl { DEFAULT = 0, ALL_CAN_READ = 1, ALL_CAN_WRITE = 1 << 1, PROHIBITS_OVERWRITING = 1 << 2 }
enum	PropertyFilter {   ALL_PROPERTIES = 0, ONLY_WRITABLE = 1, ONLY_ENUMERABLE = 2, ONLY_CONFIGURABLE = 4,   SKIP_STRINGS = 8, SKIP_SYMBOLS = 16 }
enum	SideEffectType { kHasSideEffect, kHasNoSideEffect }
enum	KeyCollectionMode { kOwnOnly, kIncludePrototypes }
enum	IndexFilter { kIncludeIndices, kSkipIndices }
enum	KeyConversionMode { kConvertToString, kKeepNumbers }
enum	IntegrityLevel { kFrozen, kSealed }
enum	ConstructorBehavior { kThrow, kAllow }
enum	ArrayBufferCreationMode { kInternalized, kExternalized }
enum	Intrinsic
enum	AccessType {   ACCESS_GET, ACCESS_SET, ACCESS_HAS, ACCESS_DELETE,   ACCESS_KEYS }
enum	PropertyHandlerFlags {   PropertyHandlerFlags::kNone = 0, PropertyHandlerFlags::kAllCanRead = 1, PropertyHandlerFlags::kNonMasking = 1 << 1, PropertyHandlerFlags::kOnlyInterceptStrings = 1 << 2,   PropertyHandlerFlags::kHasNoSideEffect = 1 << 3 }

Functions
constexpr uint32_t	CurrentValueSerializerFormatVersion ()
V8_EXPORT	length_ (0)
	ExternalOneByteStringResourceImpl (const char *data, size_t length)
const char *	data () const
size_t	length () const

Variables
V8_EXPORT	ExternalOneByteStringResourceImpl

Detailed Description

Profiler support for the V8 JavaScript engine.

Testing support for the V8 JavaScript engine.

Support for Persistent containers.

C++11 embedders can use STL containers with Global values, but pre-C++11 does not support the required move semantic and hence may want these container classes.

Compile-time constants.

This header provides access to information about the value serializer at compile time, without declaring or defining any symbols that require linking to V8.

The v8 JavaScript engine.

Typedef Documentation

AccessCheckCallback

typedef bool(* v8::AccessCheckCallback) (Local< Context > accessing_context, Local< Object > accessed_object, Local< Value > data)

Returns true if the given context should be allowed to access the given object.

AccessorGetterCallback

typedef void(* v8::AccessorGetterCallback) (Local< String > property, const PropertyCallbackInfo< Value > &info)

Accessor[Getter|Setter] are used as callback functions when setting|getting a particular property. See Object and ObjectTemplate's method SetAccessor.

GenericNamedPropertyDefinerCallback

typedef void(* v8::GenericNamedPropertyDefinerCallback) (Local< Name > property, const PropertyDescriptor &desc, const PropertyCallbackInfo< Value > &info)

Interceptor for defineProperty requests on an object.

Use info.GetReturnValue() to indicate whether the request was intercepted or not. If the definer successfully intercepts the request, i.e., if the request should not be further executed, call info.GetReturnValue().Set(value). If the definer did not intercept the request, i.e., if the request should be handled as if no interceptor is present, do not not call Set().

Parameters

property	The name of the property for which the request was intercepted.
desc	The property descriptor which is used to define the property if the request is not intercepted.
info	Information about the intercepted request, such as isolate, receiver, return value, or whether running in ‘'use strict’mode. SeePropertyCallbackInfo`.

See also ObjectTemplate::SetHandler.

GenericNamedPropertyDeleterCallback

typedef void(* v8::GenericNamedPropertyDeleterCallback) (Local< Name > property, const PropertyCallbackInfo< Boolean > &info)

Interceptor for delete requests on an object.

Use info.GetReturnValue() to indicate whether the request was intercepted or not. If the deleter successfully intercepts the request, i.e., if the request should not be further executed, call info.GetReturnValue().Set(value) with a boolean value. The value is used as the return value of delete.

Parameters

property	The name of the property for which the request was intercepted.
info	Information about the intercepted request, such as isolate, receiver, return value, or whether running in ‘'use strict’mode. SeePropertyCallbackInfo`.

Note

If you need to mimic the behavior of delete, i.e., throw in strict mode instead of returning false, use info.ShouldThrowOnError() to determine if you are in strict mode.

See also ObjectTemplate::SetHandler.

GenericNamedPropertyDescriptorCallback

typedef void(* v8::GenericNamedPropertyDescriptorCallback) (Local< Name > property, const PropertyCallbackInfo< Value > &info)

Interceptor for getOwnPropertyDescriptor requests on an object.

Use info.GetReturnValue().Set() to set the return value of the intercepted request. The return value must be an object that can be converted to a PropertyDescriptor, e.g., a v8::value returned from v8::Object::getOwnPropertyDescriptor.

Parameters

property

The name of the property for which the request was intercepted. \info Information about the intercepted request, such as isolate, receiver, return value, or whether running in ‘'use strict’mode. SeePropertyCallbackInfo`.

Note

If GetOwnPropertyDescriptor is intercepted, it will always return true, i.e., indicate that the property was found.

See also ObjectTemplate::SetHandler.

GenericNamedPropertyEnumeratorCallback

typedef void(* v8::GenericNamedPropertyEnumeratorCallback) (const PropertyCallbackInfo< Array > &info)

Returns an array containing the names of the properties the named property getter intercepts.

Note: The values in the array must be of type v8::Name.

GenericNamedPropertyGetterCallback

typedef void(* v8::GenericNamedPropertyGetterCallback) (Local< Name > property, const PropertyCallbackInfo< Value > &info)

Interceptor for get requests on an object.

Use info.GetReturnValue().Set() to set the return value of the intercepted get request.

Parameters

property	The name of the property for which the request was intercepted.
info	Information about the intercepted request, such as isolate, receiver, return value, or whether running in 'use strict' mode. See PropertyCallbackInfo.

void GetterCallback(
  Local<Name> name,
  const v8::PropertyCallbackInfo<v8::Value>& info) {
    info.GetReturnValue().Set(v8_num(42));
}

v8::Local<v8::FunctionTemplate> templ =
    v8::FunctionTemplate::New(isolate);
templ->InstanceTemplate()->SetHandler(
    v8::NamedPropertyHandlerConfiguration(GetterCallback));
LocalContext env;
env->Global()
    ->Set(env.local(), v8_str("obj"), templ->GetFunction(env.local())
                                           .ToLocalChecked()
                                           ->NewInstance(env.local())
                                           .ToLocalChecked())
    .FromJust();
v8::Local<v8::Value> result = CompileRun("obj.a = 17; obj.a");
CHECK(v8_num(42)->Equals(env.local(), result).FromJust());

See also ObjectTemplate::SetHandler.

GenericNamedPropertyQueryCallback

typedef void(* v8::GenericNamedPropertyQueryCallback) (Local< Name > property, const PropertyCallbackInfo< Integer > &info)

Intercepts all requests that query the attributes of the property, e.g., getOwnPropertyDescriptor(), propertyIsEnumerable(), and defineProperty().

Use info.GetReturnValue().Set(value) to set the property attributes. The value is an integer encoding a v8::PropertyAttribute.

Parameters

property	The name of the property for which the request was intercepted.
info	Information about the intercepted request, such as isolate, receiver, return value, or whether running in ‘'use strict’mode. SeePropertyCallbackInfo`.

Note

Some functions query the property attributes internally, even though they do not return the attributes. For example, hasOwnProperty() can trigger this interceptor depending on the state of the object.

See also ObjectTemplate::SetHandler.

GenericNamedPropertySetterCallback

typedef void(* v8::GenericNamedPropertySetterCallback) (Local< Name > property, Local< Value > value, const PropertyCallbackInfo< Value > &info)

Interceptor for set requests on an object.

Use info.GetReturnValue() to indicate whether the request was intercepted or not. If the setter successfully intercepts the request, i.e., if the request should not be further executed, call info.GetReturnValue().Set(value). If the setter did not intercept the request, i.e., if the request should be handled as if no interceptor is present, do not not call Set().

Parameters

property	The name of the property for which the request was intercepted.
value	The value which the property will have if the request is not intercepted.
info	Information about the intercepted request, such as isolate, receiver, return value, or whether running in ‘'use strict’mode. SeePropertyCallbackInfo`.

See also ObjectTemplate::SetHandler.

IndexedPropertyDefinerCallback

typedef void(* v8::IndexedPropertyDefinerCallback) (uint32_t index, const PropertyDescriptor &desc, const PropertyCallbackInfo< Value > &info)

See v8::GenericNamedPropertyDefinerCallback.

IndexedPropertyDeleterCallback

typedef void(* v8::IndexedPropertyDeleterCallback) (uint32_t index, const PropertyCallbackInfo< Boolean > &info)

See v8::GenericNamedPropertyDeleterCallback.

IndexedPropertyDescriptorCallback

typedef void(* v8::IndexedPropertyDescriptorCallback) (uint32_t index, const PropertyCallbackInfo< Value > &info)

See v8::GenericNamedPropertyDescriptorCallback.

IndexedPropertyEnumeratorCallback

typedef void(* v8::IndexedPropertyEnumeratorCallback) (const PropertyCallbackInfo< Array > &info)

Returns an array containing the indices of the properties the indexed property getter intercepts.

Note: The values in the array must be uint32_t.

IndexedPropertyGetterCallback

typedef void(* v8::IndexedPropertyGetterCallback) (uint32_t index, const PropertyCallbackInfo< Value > &info)

See v8::GenericNamedPropertyGetterCallback.

IndexedPropertyQueryCallback

typedef void(* v8::IndexedPropertyQueryCallback) (uint32_t index, const PropertyCallbackInfo< Integer > &info)

See v8::GenericNamedPropertyQueryCallback.

IndexedPropertySetterCallback

typedef void(* v8::IndexedPropertySetterCallback) (uint32_t index, Local< Value > value, const PropertyCallbackInfo< Value > &info)

See v8::GenericNamedPropertySetterCallback.

Enumeration Type Documentation

AccessControl

enum v8::AccessControl

Access control specifications.

Some accessors should be accessible across contexts. These accessors have an explicit access control parameter which specifies the kind of cross-context access that should be allowed.

TODO(dcarney): Remove PROHIBITS_OVERWRITING as it is now unused.

AccessType

enum v8::AccessType

Access type specification.

CodeEventType

enum v8::CodeEventType

Note that this enum may be extended in the future. Please include a default case if this enum is used in a switch statement.

IndexFilter

enum v8::IndexFilter

strong

kIncludesIndices allows for integer indices to be collected, while kSkipIndices will exclude integer indices from being collected.

IntegrityLevel

enum v8::IntegrityLevel

strong

Integrity level for objects.

KeyCollectionMode

enum v8::KeyCollectionMode

strong

Keys/Properties filter enums:

KeyCollectionMode limits the range of collected properties. kOwnOnly limits the collected properties to the given Object only. kIncludesPrototypes will include all keys of the objects's prototype chain as well.

KeyConversionMode

enum v8::KeyConversionMode

strong

kConvertToString will convert integer indices to strings. kKeepNumbers will return numbers for integer indices.

NewStringType

enum v8::NewStringType

strong

A flag describing different modes of string creation.

Aside from performance implications there are no differences between the two creation modes.

Enumerator
kNormal	Create a new string, always allocating new storage memory.
kInternalized	Acts as a hint that the string should be created in the old generation heap space and be deduplicated if an identical string already exists.

PropertyAttribute

enum v8::PropertyAttribute

PropertyAttribute.

Enumerator
None	None.
ReadOnly	ReadOnly, i.e., not writable.
DontEnum	DontEnum, i.e., not enumerable.
DontDelete	DontDelete, i.e., not configurable.

PropertyFilter

enum v8::PropertyFilter

Property filter bits. They can be or'ed to build a composite filter.

PropertyHandlerFlags

enum v8::PropertyHandlerFlags

strong

Configuration flags for v8::NamedPropertyHandlerConfiguration or v8::IndexedPropertyHandlerConfiguration.

Enumerator
kNone	None.
kAllCanRead	See ALL_CAN_READ above.
kNonMasking	Will not call into interceptor for properties on the receiver or prototype chain, i.e., only call into interceptor for properties that do not exist. Currently only valid for named interceptors.
kOnlyInterceptStrings	Will not call into interceptor for symbol lookup. Only meaningful for named interceptors.
kHasNoSideEffect	The getter, query, enumerator callbacks do not produce side effects.

SideEffectType

enum v8::SideEffectType

strong

Options for marking whether callbacks may trigger JS-observable side effects. Side-effect-free callbacks are whitelisted during debug evaluation with throwOnSideEffect. It applies when calling a Function, FunctionTemplate, or an Accessor's getter callback. For Interceptors, please see PropertyHandlerFlags's kHasNoSideEffect.