v8  6.8.275 (node 10.15.3)
V8 is Google's open source JavaScript engine
Public Member Functions | Static Public Member Functions
Value Class Reference

#include <v8.h>

Inheritance diagram for Value:
Inheritance graph
[legend]
Collaboration diagram for Value:
Collaboration graph
[legend]

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< 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_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< 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_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< String > TypeOf (Isolate *)
 
Maybe< bool > InstanceOf (Local< Context > context, Local< Object > object)
 
template<class T >
Value * Cast (T *value)
 

Static Public Member Functions

template<class T >
static V8_INLINE Value * Cast (T *value)
 

Detailed Description

The superclass of all JavaScript values and objects.

Definition at line 2227 of file v8.h.

Member Function Documentation

◆ BooleanValue()

V8_WARN_UNUSED_RESULT Maybe<bool> BooleanValue ( Local< Context >  context) const

◆ Cast() [1/2]

static V8_INLINE Value* Cast ( T *  value)
static

◆ Cast() [2/2]

Value* Cast ( T *  value)

Definition at line 9987 of file v8.h.

◆ Equals()

V8_WARN_UNUSED_RESULT Maybe<bool> Equals ( Local< Context >  context,
Local< Value >  that 
) const

◆ InstanceOf()

Maybe<bool> InstanceOf ( Local< Context >  context,
Local< Object >  object 
)

◆ Int32Value()

V8_WARN_UNUSED_RESULT Maybe<int32_t> Int32Value ( Local< Context >  context) const

◆ IntegerValue()

V8_WARN_UNUSED_RESULT Maybe<int64_t> IntegerValue ( Local< Context >  context) const

◆ IsArgumentsObject()

bool IsArgumentsObject ( ) const

Returns true if this value is an Arguments object.

◆ IsArray()

bool IsArray ( ) const

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

◆ IsArrayBuffer()

bool IsArrayBuffer ( ) const

Returns true if this value is an ArrayBuffer.

◆ IsArrayBufferView()

bool IsArrayBufferView ( ) const

Returns true if this value is an ArrayBufferView.

◆ IsAsyncFunction()

bool IsAsyncFunction ( ) const

Returns true if this value is an async function.

◆ IsBigInt()

bool IsBigInt ( ) const

Returns true if this value is a bigint.

◆ IsBigInt64Array()

bool IsBigInt64Array ( ) const

Returns true if this value is a BigInt64Array.

◆ IsBigIntObject()

bool IsBigIntObject ( ) const

Returns true if this value is a BigInt object.

◆ IsBigUint64Array()

bool IsBigUint64Array ( ) const

Returns true if this value is a BigUint64Array.

◆ IsBoolean()

bool IsBoolean ( ) const

Returns true if this value is boolean.

◆ IsBooleanObject()

bool IsBooleanObject ( ) const

Returns true if this value is a Boolean object.

◆ IsDataView()

bool IsDataView ( ) const

Returns true if this value is a DataView.

◆ IsDate()

bool IsDate ( ) const

Returns true if this value is a Date.

◆ IsExternal()

bool IsExternal ( ) const

Returns true if this value is external.

◆ IsFalse()

bool IsFalse ( ) const

Returns true if this value is false.

◆ IsFloat32Array()

bool IsFloat32Array ( ) const

Returns true if this value is a Float32Array.

◆ IsFloat64Array()

bool IsFloat64Array ( ) const

Returns true if this value is a Float64Array.

◆ IsFunction()

bool IsFunction ( ) const

Returns true if this value is a function.

◆ IsGeneratorFunction()

bool IsGeneratorFunction ( ) const

Returns true if this value is a Generator function.

◆ IsGeneratorObject()

bool IsGeneratorObject ( ) const

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

◆ IsInt16Array()

bool IsInt16Array ( ) const

Returns true if this value is an Int16Array.

◆ IsInt32()

bool IsInt32 ( ) const

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

◆ IsInt32Array()

bool IsInt32Array ( ) const

Returns true if this value is an Int32Array.

◆ IsInt8Array()

bool IsInt8Array ( ) const

Returns true if this value is an Int8Array.

◆ IsMap()

bool IsMap ( ) const

Returns true if this value is a Map.

◆ IsMapIterator()

bool IsMapIterator ( ) const

Returns true if this value is a Map Iterator.

◆ IsModuleNamespaceObject()

bool IsModuleNamespaceObject ( ) const

Returns true if the value is a Module Namespace Object.

◆ IsName()

bool IsName ( ) const

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

◆ IsNativeError()

bool IsNativeError ( ) const

Returns true if this value is a NativeError.

◆ IsNull()

bool IsNull ( ) const

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

Definition at line 9935 of file v8.h.

◆ IsNullOrUndefined()

bool 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

Definition at line 9952 of file v8.h.

◆ IsNumber()

bool IsNumber ( ) const

Returns true if this value is a number.

◆ IsNumberObject()

bool IsNumberObject ( ) const

Returns true if this value is a Number object.

◆ IsObject()

bool IsObject ( ) const

Returns true if this value is an object.

◆ IsPromise()

bool IsPromise ( ) const

Returns true if this value is a Promise.

◆ IsProxy()

bool IsProxy ( ) const

Returns true if this value is a JavaScript Proxy.

◆ IsRegExp()

bool IsRegExp ( ) const

Returns true if this value is a RegExp.

◆ IsSet()

bool IsSet ( ) const

Returns true if this value is a Set.

◆ IsSetIterator()

bool IsSetIterator ( ) const

Returns true if this value is a Set Iterator.

◆ IsSharedArrayBuffer()

bool IsSharedArrayBuffer ( ) const

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

◆ IsString()

bool IsString ( ) const

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

Definition at line 9970 of file v8.h.

◆ IsStringObject()

bool IsStringObject ( ) const

Returns true if this value is a String object.

◆ IsSymbol()

bool IsSymbol ( ) const

Returns true if this value is a symbol.

◆ IsSymbolObject()

bool IsSymbolObject ( ) const

Returns true if this value is a Symbol object.

◆ IsTrue()

bool IsTrue ( ) const

Returns true if this value is true.

Referenced by ScriptOrigin::ScriptOrigin().

◆ IsTypedArray()

bool IsTypedArray ( ) const

Returns true if this value is one of TypedArrays.

◆ IsUint16Array()

bool IsUint16Array ( ) const

Returns true if this value is an Uint16Array.

◆ IsUint32()

bool IsUint32 ( ) const

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

◆ IsUint32Array()

bool IsUint32Array ( ) const

Returns true if this value is an Uint32Array.

◆ IsUint8Array()

bool IsUint8Array ( ) const

Returns true if this value is an Uint8Array.

◆ IsUint8ClampedArray()

bool IsUint8ClampedArray ( ) const

Returns true if this value is an Uint8ClampedArray.

◆ IsUndefined()

bool IsUndefined ( ) const

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

Definition at line 9917 of file v8.h.

◆ IsWeakMap()

bool IsWeakMap ( ) const

Returns true if this value is a WeakMap.

◆ IsWeakSet()

bool IsWeakSet ( ) const

Returns true if this value is a WeakSet.

◆ IsWebAssemblyCompiledModule()

bool IsWebAssemblyCompiledModule ( ) const

◆ NumberValue()

V8_WARN_UNUSED_RESULT Maybe<double> NumberValue ( Local< Context >  context) const

◆ SameValue()

bool SameValue ( Local< Value >  that) const

◆ StrictEquals()

bool StrictEquals ( Local< Value >  that) const

◆ ToArrayIndex()

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

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

◆ ToBigInt()

V8_WARN_UNUSED_RESULT MaybeLocal<BigInt> ToBigInt ( Local< Context >  context) const

◆ ToBoolean()

Local< Boolean > ToBoolean ( Local< Context >  context) const

Definition at line 9992 of file v8.h.

References Isolate::GetCurrent(), Isolate::GetCurrentContext(), Local< T >::Local, and Value::ToBoolean().

Referenced by Value::ToBoolean().

◆ ToDetailString()

V8_WARN_UNUSED_RESULT MaybeLocal<String> ToDetailString ( Local< Context >  context) const

◆ ToInt32()

V8_WARN_UNUSED_RESULT MaybeLocal<Int32> ToInt32 ( Local< Context >  context) const

◆ ToInteger()

Local< Integer > ToInteger ( Local< Context >  context) const

Definition at line 10010 of file v8.h.

References Isolate::GetCurrent(), Isolate::GetCurrentContext(), Local< T >::Local, and Value::ToInteger().

Referenced by Value::ToInteger().

◆ ToNumber()

V8_WARN_UNUSED_RESULT MaybeLocal<Number> ToNumber ( Local< Context >  context) const

◆ ToObject()

Local< Object > ToObject ( Local< Context >  context) const

Definition at line 10004 of file v8.h.

References Isolate::GetCurrent(), Isolate::GetCurrentContext(), Local< T >::Local, and Value::ToObject().

Referenced by Value::ToObject().

◆ ToString()

Local< String > ToString ( Local< Context >  context) const

Definition at line 9998 of file v8.h.

References Isolate::GetCurrent(), Isolate::GetCurrentContext(), Local< T >::Local, and Value::ToString().

Referenced by Value::ToString().

◆ ToUint32()

V8_WARN_UNUSED_RESULT MaybeLocal<Uint32> ToUint32 ( Local< Context >  context) const

◆ TypeOf()

Local<String> TypeOf ( Isolate *  )

◆ Uint32Value()

V8_WARN_UNUSED_RESULT Maybe<uint32_t> Uint32Value ( Local< Context >  context) const

◆ V8_DEPRECATE_SOON() [1/16]

V8_DEPRECATE_SOON ( "Use maybe version"  ,
bool BooleanValue() const   
)

◆ V8_DEPRECATE_SOON() [2/16]

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

JS ==

◆ V8_DEPRECATE_SOON() [3/16]

V8_DEPRECATE_SOON ( "Use maybe version"  ,
double NumberValue() const   
)

◆ V8_DEPRECATE_SOON() [4/16]

V8_DEPRECATE_SOON ( "Use maybe version"  ,
int32_t Int32Value() const   
)

◆ V8_DEPRECATE_SOON() [5/16]

V8_DEPRECATE_SOON ( "Use maybe version"  ,
int64_t IntegerValue() const   
)

◆ V8_DEPRECATE_SOON() [6/16]

V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< Boolean > ToBoolean() const   
)
inline

◆ V8_DEPRECATE_SOON() [7/16]

V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< Boolean > ToBoolean(Isolate *isolate) const   
)

◆ V8_DEPRECATE_SOON() [8/16]

V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< Int32 > ToInt32(Isolate *isolate) const   
)

◆ V8_DEPRECATE_SOON() [9/16]

V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< Integer > ToInteger() const   
)
inline

◆ V8_DEPRECATE_SOON() [10/16]

V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< Integer > ToInteger(Isolate *isolate) const   
)

◆ V8_DEPRECATE_SOON() [11/16]

V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< Number > ToNumber(Isolate *isolate) const   
)

◆ V8_DEPRECATE_SOON() [12/16]

V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< Object > ToObject() const   
)
inline

◆ V8_DEPRECATE_SOON() [13/16]

V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< Object > ToObject(Isolate *isolate) const   
)

◆ V8_DEPRECATE_SOON() [14/16]

V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< String > ToString() const   
)
inline

◆ V8_DEPRECATE_SOON() [15/16]

V8_DEPRECATE_SOON ( "Use maybe version"  ,
Local< String > ToString(Isolate *isolate) const   
)

◆ V8_DEPRECATE_SOON() [16/16]

V8_DEPRECATE_SOON ( "Use maybe version"  ,
uint32_t Uint32Value() const   
)
The documentation for this class was generated from the following file: