V8 API Reference Guide generated from the header files
Public Member Functions | Static Public Member Functions
v8::Value Class Reference

#include <v8.h>

Inheritance diagram for v8::Value:
v8::Data v8::External v8::Object v8::Primitive v8::Array v8::ArrayBuffer v8::ArrayBufferView v8::BigIntObject v8::BooleanObject v8::Date 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 v8::BigInt v8::Boolean v8::Name v8::Number

Public Member Functions

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_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< 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_DEPRECATE_SOON ("Use maybe version", Local< Boolean > ToBoolean() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< String > ToString() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Object > ToObject() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Integer > ToInteger() 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
 
Local< StringTypeOf (Isolate *)
 
Maybe< bool > InstanceOf (Local< Context > context, Local< Object > object)
 
template<class T >
ValueCast (T *value)
 

Static Public Member Functions

template<class T >
static V8_INLINE ValueCast (T *value)
 

Detailed Description

The superclass of all JavaScript values and objects.

Member Function Documentation

◆ IsArgumentsObject()

bool v8::Value::IsArgumentsObject ( ) const

Returns true if this value is an Arguments object.

◆ IsArray()

bool v8::Value::IsArray ( ) const

Returns true if this value is an array. Note that it will return false for an Proxy for an array.

◆ IsArrayBuffer()

bool v8::Value::IsArrayBuffer ( ) const

Returns true if this value is an ArrayBuffer.

◆ IsArrayBufferView()

bool v8::Value::IsArrayBufferView ( ) const

Returns true if this value is an ArrayBufferView.

◆ IsAsyncFunction()

bool v8::Value::IsAsyncFunction ( ) const

Returns true if this value is an async function.

◆ IsBigInt()

bool v8::Value::IsBigInt ( ) const

Returns true if this value is a bigint.

◆ IsBigInt64Array()

bool v8::Value::IsBigInt64Array ( ) const

Returns true if this value is a BigInt64Array.

◆ IsBigIntObject()

bool v8::Value::IsBigIntObject ( ) const

Returns true if this value is a BigInt object.

◆ IsBigUint64Array()

bool v8::Value::IsBigUint64Array ( ) const

Returns true if this value is a BigUint64Array.

◆ IsBoolean()

bool v8::Value::IsBoolean ( ) const

Returns true if this value is boolean.

◆ IsBooleanObject()

bool v8::Value::IsBooleanObject ( ) const

Returns true if this value is a Boolean object.

◆ IsDataView()

bool v8::Value::IsDataView ( ) const

Returns true if this value is a DataView.

◆ IsDate()

bool v8::Value::IsDate ( ) const

Returns true if this value is a Date.

◆ IsExternal()

bool v8::Value::IsExternal ( ) const

Returns true if this value is external.

◆ IsFalse()

bool v8::Value::IsFalse ( ) const

Returns true if this value is false.

◆ IsFloat32Array()

bool v8::Value::IsFloat32Array ( ) const

Returns true if this value is a Float32Array.

◆ IsFloat64Array()

bool v8::Value::IsFloat64Array ( ) const

Returns true if this value is a Float64Array.

◆ IsFunction()

bool v8::Value::IsFunction ( ) const

Returns true if this value is a function.

◆ IsGeneratorFunction()

bool v8::Value::IsGeneratorFunction ( ) const

Returns true if this value is a Generator function.

◆ IsGeneratorObject()

bool v8::Value::IsGeneratorObject ( ) const

Returns true if this value is a Generator object (iterator).

◆ IsInt16Array()

bool v8::Value::IsInt16Array ( ) const

Returns true if this value is an Int16Array.

◆ IsInt32()

bool v8::Value::IsInt32 ( ) const

Returns true if this value is a 32-bit signed integer.

◆ IsInt32Array()

bool v8::Value::IsInt32Array ( ) const

Returns true if this value is an Int32Array.

◆ IsInt8Array()

bool v8::Value::IsInt8Array ( ) const

Returns true if this value is an Int8Array.

◆ IsMap()

bool v8::Value::IsMap ( ) const

Returns true if this value is a Map.

◆ IsMapIterator()

bool v8::Value::IsMapIterator ( ) const

Returns true if this value is a Map Iterator.

◆ IsModuleNamespaceObject()

bool v8::Value::IsModuleNamespaceObject ( ) const

Returns true if the value is a Module Namespace Object.

◆ IsName()

bool v8::Value::IsName ( ) const

Returns true if this value is a symbol or a string.

◆ IsNativeError()

bool v8::Value::IsNativeError ( ) const

Returns true if this value is a NativeError.

◆ IsNull()

bool v8::Value::IsNull ( ) const

Returns true if this value is the null value. See ECMA-262 4.3.11.

◆ IsNullOrUndefined()

bool v8::Value::IsNullOrUndefined ( ) const

Returns true if this value is either the null or the undefined value. See ECMA-262 4.3.11. and 4.3.12

◆ IsNumber()

bool v8::Value::IsNumber ( ) const

Returns true if this value is a number.

◆ IsNumberObject()

bool v8::Value::IsNumberObject ( ) const

Returns true if this value is a Number object.

◆ IsObject()

bool v8::Value::IsObject ( ) const

Returns true if this value is an object.

◆ IsPromise()

bool v8::Value::IsPromise ( ) const

Returns true if this value is a Promise.

◆ IsProxy()

bool v8::Value::IsProxy ( ) const

Returns true if this value is a JavaScript Proxy.

◆ IsRegExp()

bool v8::Value::IsRegExp ( ) const

Returns true if this value is a RegExp.

◆ IsSet()

bool v8::Value::IsSet ( ) const

Returns true if this value is a Set.

◆ IsSetIterator()

bool v8::Value::IsSetIterator ( ) const

Returns true if this value is a Set Iterator.

◆ IsSharedArrayBuffer()

bool v8::Value::IsSharedArrayBuffer ( ) const

Returns true if this value is a SharedArrayBuffer. This is an experimental feature.

◆ IsString()

bool v8::Value::IsString ( ) const

Returns true if this value is an instance of the String type. See ECMA-262 8.4.

◆ IsStringObject()

bool v8::Value::IsStringObject ( ) const

Returns true if this value is a String object.

◆ IsSymbol()

bool v8::Value::IsSymbol ( ) const

Returns true if this value is a symbol.

◆ IsSymbolObject()

bool v8::Value::IsSymbolObject ( ) const

Returns true if this value is a Symbol object.

◆ IsTrue()

bool v8::Value::IsTrue ( ) const

Returns true if this value is true.

◆ IsTypedArray()

bool v8::Value::IsTypedArray ( ) const

Returns true if this value is one of TypedArrays.

◆ IsUint16Array()

bool v8::Value::IsUint16Array ( ) const

Returns true if this value is an Uint16Array.

◆ IsUint32()

bool v8::Value::IsUint32 ( ) const

Returns true if this value is a 32-bit unsigned integer.

◆ IsUint32Array()

bool v8::Value::IsUint32Array ( ) const

Returns true if this value is an Uint32Array.

◆ IsUint8Array()

bool v8::Value::IsUint8Array ( ) const

Returns true if this value is an Uint8Array.

◆ IsUint8ClampedArray()

bool v8::Value::IsUint8ClampedArray ( ) const

Returns true if this value is an Uint8ClampedArray.

◆ IsUndefined()

bool v8::Value::IsUndefined ( ) const

Returns true if this value is the undefined value. See ECMA-262 4.3.10.

◆ IsWeakMap()

bool v8::Value::IsWeakMap ( ) const

Returns true if this value is a WeakMap.

◆ IsWeakSet()

bool v8::Value::IsWeakSet ( ) const

Returns true if this value is a WeakSet.

◆ ToArrayIndex()

V8_WARN_UNUSED_RESULT MaybeLocal<Uint32> v8::Value::ToArrayIndex ( Local< Context context) const

Attempts to convert a string to an array index. Returns an empty handle if the conversion fails.

◆ V8_DEPRECATE_SOON()

v8::Value::V8_DEPRECATE_SOON ( "Use maybe version"  ,
bool Equals(Local< Value > that)  const 
)

JS ==


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