v8  8.4.371(node14.15.0)
V8 is Google's open source JavaScript engine
Symbol Class Reference

#include <v8.h>

Inheritance diagram for Symbol:
Collaboration diagram for Symbol:

Public Member Functions

Local< ValueDescription () const
 
Local< ValueName () 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 IsModuleNamespaceObject () const
 
V8_WARN_UNUSED_RESULT MaybeLocal< BigIntToBigInt (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
 
Local< BooleanToBoolean (Isolate *isolate) const
 
V8_WARN_UNUSED_RESULT MaybeLocal< Uint32ToArrayIndex (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< StringTypeOf (Isolate *)
 
Maybe< bool > InstanceOf (Local< Context > context, Local< Object > object)
 
template<class T >
ValueCast (T *value)
 

Static Public Member Functions

static Local< SymbolNew (Isolate *isolate, Local< String > description=Local< String >())
 
static Local< SymbolFor (Isolate *isolate, Local< String > description)
 
static Local< SymbolForApi (Isolate *isolate, Local< String > description)
 
static Local< SymbolGetAsyncIterator (Isolate *isolate)
 
static Local< SymbolGetHasInstance (Isolate *isolate)
 
static Local< SymbolGetIsConcatSpreadable (Isolate *isolate)
 
static Local< SymbolGetIterator (Isolate *isolate)
 
static Local< SymbolGetMatch (Isolate *isolate)
 
static Local< SymbolGetReplace (Isolate *isolate)
 
static Local< SymbolGetSearch (Isolate *isolate)
 
static Local< SymbolGetSplit (Isolate *isolate)
 
static Local< SymbolGetToPrimitive (Isolate *isolate)
 
static Local< SymbolGetToStringTag (Isolate *isolate)
 
static Local< SymbolGetUnscopables (Isolate *isolate)
 
static V8_INLINE SymbolCast (Value *obj)
 
- Static Public Member Functions inherited from Name
static V8_INLINE NameCast (Value *obj)
 
- Static Public Member Functions inherited from Value
template<class T >
static V8_INLINE ValueCast (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 11523 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 = LocalString >() 
)
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: