#include <v8.h>

Inheritance diagram for Symbol:

Collaboration diagram for Symbol:

Public Member Functions
Local< Value >	Description () const

Local< Value >	Name () const

Public Member Functions inherited from Name
int	GetIdentityHash ()

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	IsWasmModuleObject () const

bool	IsWebAssemblyCompiledModule () const

bool	IsModuleNamespaceObject () const

V8_WARN_UNUSED_RESULT MaybeLocal< BigInt >	ToBigInt (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

Local< Boolean >	ToBoolean (Isolate *isolate) const

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

bool	BooleanValue (Isolate *isolate) 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)

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

Static Public Member Functions
static Local< Symbol >	New (Isolate *isolate, Local< String > description=Local< String >())

static Local< Symbol >	For (Isolate *isolate, Local< String > description)

static Local< Symbol >	ForApi (Isolate *isolate, Local< String > description)

static Local< Symbol >	GetAsyncIterator (Isolate *isolate)

static Local< Symbol >	GetHasInstance (Isolate *isolate)

static Local< Symbol >	GetIsConcatSpreadable (Isolate *isolate)

static Local< Symbol >	GetIterator (Isolate *isolate)

static Local< Symbol >	GetMatch (Isolate *isolate)

static Local< Symbol >	GetReplace (Isolate *isolate)

static Local< Symbol >	GetSearch (Isolate *isolate)

static Local< Symbol >	GetSplit (Isolate *isolate)

static Local< Symbol >	GetToPrimitive (Isolate *isolate)

static Local< Symbol >	GetToStringTag (Isolate *isolate)

static Local< Symbol >	GetUnscopables (Isolate *isolate)

static V8_INLINE Symbol *	Cast (Value *obj)

Static Public Member Functions inherited from Name
static V8_INLINE Name *	Cast (Value *obj)

Static Public Member Functions inherited from Value
template<class T >
static V8_INLINE Value *	Cast (T *value)

Detailed Description

A JavaScript symbol (ECMA-262 edition 6)

Definition at line 3349 of file v8.h.

Member Function Documentation

◆ Cast()

Symbol * Cast ( v8::Value * value )

static

Definition at line 11438 of file v8.h.

◆ Description()

Local<Value> Description ( ) const

Returns the description string of the symbol, or undefined if none.

Referenced by Symbol::Name().

◆ For()

static Local<Symbol> For	(	Isolate *	isolate,
		Local< String >	description
	)

static

Access global symbol registry. Note that symbols created this way are never collected, so they should only be used for statically fixed properties. Also, there is only one global name space for the descriptions used as keys. To minimize the potential for clashes, use qualified names as keys.

◆ ForApi()

static Local<Symbol> ForApi	(	Isolate *	isolate,
		Local< String >	description
	)

static

Retrieve a global symbol. Similar to |For|, but using a separate registry that is not accessible by (and cannot clash with) JavaScript code.

◆ GetAsyncIterator()

static Local<Symbol> GetAsyncIterator ( Isolate * isolate )

static

◆ GetHasInstance()

static Local<Symbol> GetHasInstance ( Isolate * isolate )

static

◆ GetIsConcatSpreadable()

static Local<Symbol> GetIsConcatSpreadable ( Isolate * isolate )

static

◆ GetIterator()

static Local<Symbol> GetIterator ( Isolate * isolate )

static

◆ GetMatch()

static Local<Symbol> GetMatch ( Isolate * isolate )

static

◆ GetReplace()

static Local<Symbol> GetReplace ( Isolate * isolate )

static

◆ GetSearch()

static Local<Symbol> GetSearch ( Isolate * isolate )

static

◆ GetSplit()

static Local<Symbol> GetSplit ( Isolate * isolate )

static

◆ GetToPrimitive()

static Local<Symbol> GetToPrimitive ( Isolate * isolate )

static

◆ GetToStringTag()

static Local<Symbol> GetToStringTag ( Isolate * isolate )

static

◆ GetUnscopables()

static Local<Symbol> GetUnscopables ( Isolate * isolate )

static

◆ Name()

Local<Value> Name ( ) const

inline

Definition at line 3357 of file v8.h.

References Symbol::Description().

◆ New()

static Local<Symbol> New	(	Isolate *	isolate,
		Local< String >	description = `Local< String >()`
	)

static

Create a symbol. If description is not empty, it will be used as the description.

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

include/v8.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ Cast()

◆ Description()

◆ For()

◆ ForApi()

◆ GetAsyncIterator()

◆ GetHasInstance()

◆ GetIsConcatSpreadable()

◆ GetIterator()

◆ GetMatch()

◆ GetReplace()

◆ GetSearch()

◆ GetSplit()

◆ GetToPrimitive()

◆ GetToStringTag()

◆ GetUnscopables()

◆ Name()

◆ New()