V8 API Reference Guide for node.js v9.10.0 - v9.11.1
Public Member Functions | Static Public Member Functions | List of all members
v8::Symbol Class Reference

#include <v8.h>

Inheritance diagram for v8::Symbol:
Inheritance graph
[legend]
Collaboration diagram for v8::Symbol:
Collaboration graph
[legend]

Public Member Functions

Local< ValueName () const
 
- Public Member Functions inherited from v8::Name
int GetIdentityHash ()
 
- Public Member Functions inherited from v8::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 IsBoolean () const
 
bool IsNumber () const
 
bool IsExternal () const
 
bool IsInt32 () const
 
bool IsUint32 () const
 
bool IsDate () const
 
bool IsArgumentsObject () 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 IsDataView () const
 
bool IsSharedArrayBuffer () const
 
bool IsProxy () const
 
bool IsWebAssemblyCompiledModule () 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_DEPRECATED ("Use maybe version", Local< String > ToDetailString(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_DEPRECATED ("Use maybe version", Local< Uint32 > ToUint32(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_DEPRECATED ("Use maybe version", Local< Number > ToNumber() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< String > ToString() const)
 
 V8_DEPRECATED ("Use maybe version", Local< String > ToDetailString() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Object > ToObject() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Integer > ToInteger() const)
 
 V8_DEPRECATED ("Use maybe version", Local< Uint32 > ToUint32() const)
 
 V8_DEPRECATED ("Use maybe version", Local< Int32 > ToInt32() const)
 
 V8_DEPRECATED ("Use maybe version", Local< Uint32 > ToArrayIndex() 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

static Local< SymbolNew (Isolate *isolate, Local< String > name=Local< String >())
 
static Local< SymbolFor (Isolate *isolate, Local< String > name)
 
static Local< SymbolForApi (Isolate *isolate, Local< String > name)
 
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 v8::Name
static V8_INLINE NameCast (Value *obj)
 
- Static Public Member Functions inherited from v8::Value
template<class T >
static V8_INLINE ValueCast (T *value)
 

Detailed Description

A JavaScript symbol (ECMA-262 edition 6)

Member Function Documentation

static Local<Symbol> v8::Symbol::For ( Isolate isolate,
Local< String name 
)
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 names used as keys. To minimize the potential for clashes, use qualified names as keys.

static Local<Symbol> v8::Symbol::ForApi ( Isolate isolate,
Local< String name 
)
static

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

Local<Value> v8::Symbol::Name ( ) const

Returns the print name string of the symbol, or undefined if none.

static Local<Symbol> v8::Symbol::New ( Isolate isolate,
Local< String name = LocalString >() 
)
static

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


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