Symbol

Symbol

Symbol()函数会返回symbol?类型的值，该类型具有静态属性和静态方法。它的静态属性会暴露几个内建的成员对象；它的静态方法会暴露全局的symbol注册，且类似于内建对象类，但作为构造函数来说它并不完整，因为它不支持语法："new Symbol()"。

每个从Symbol()返回的symbol值都是唯一的。一个symbol值能作为对象属性的标识符；这是该数据类型仅有的目的。更进一步的解析见—— glossary entry for Symbol。

symbol 是一种基本数据类型 （primitive data type）。

语法

Symbol([description])

参数

description可选的，字符串。symbol的description可以用于调试，但无法访问到symbol本身。

描述

直接使用Symbol()创建新的symbol类型，并用一个字符串（可省略）作为其描述。

var sym1 = Symbol(
var sym2 = Symbol('foo'
var sym3 = Symbol('foo'

上面的代码创建了三个新的symbol类型。 注意，Symbol("foo")不会强制字符串 “foo” 成为一个 symbol类型。它每次都会创建一个新的 symbol类型：

Symbol('foo') === Symbol('foo' // false

下面使用 new 运算符的语法将会抛出一个 TypeError 错误：

var sym = new Symbol( // TypeError

这会阻止创建一个显式的 Symbol 包装器对象而不是一个 Symbol 值。围绕原始数据类型创建一个显式包装器对象从 ECMAScript 6 开始不再被支持。 然而，现有的原始包装器对象，如 new Boolean、new String以及new Number因为遗留原因仍可被创建。

如果你真的想创建一个Symbol 包装器对象 (Symbol wrapper object)，你可以使用Object()函数：

var sym = Symbol('foo'
typeof sym;     // "symbol" 
var symObj = Object(sym
typeof symObj;  // "object"

全局共享的 Symbol

上面使用Symbol() 函数的语法，不会在你的整个代码库中创建一个可用的全局?symbol类型。 要创建跨文件可用的symbol，甚至跨域（每个都有它自己的全局作用域） , 使用 Symbol.for() 方法和  Symbol.keyFor() 方法从全局的symbol注册?表设置和取得symbol。

在对象中查找 Symbol 属性

Object.getOwnPropertySymbols() 方法让你在查找一个给定对象的符号属性时返回一个?symbol类型的数组。注意，每个初始化的对象都是没有自己的symbol属性的，因此这个数组可能为空，除非你已经在对象上设置了symbol属性。

属性

Symbol.length长度属性值为0。

Well-known symbols

除了自己创建的symbol，JavaScript还内建了一些在ECMAScript 5 之前没有暴露给开发者的symbol，它们代表了内部语言行为。它们可以使用以下属性访问：

迭代 symbols

Symbol.iterator一个返回一个对象默认迭代器的方法。使用 for...of。

正则表达式 symbols

Symbol.match一个用于对字符串进行匹配的方法，也用于确定一个对象是否可以作为正则表达式使用。使用String.prototype.match().

其他 symbols

Symbol.hasInstance一个确定一个构造器对象识别的对象是否为它的实例的方法。使用 instanceof.

方法

Symbol.for(key)使用给定的key搜索现有的symbol，如果找到则返回该symbol。否则将使用给定的key在全局symbol注册表中创建一个新的symbol。

Symbol 原型

所有 Symbol 继承自Symbol.prototype.

属性

Symbol.prototype.constructor返回创建实例原型的函数. 默认为 Symbol函数。

方法

Symbol.prototype.toSource()返回包含Symbol对象源码的字符串。覆盖Object.prototype.toSource()方法。

示例

对 symbol 使用 typeof 运算符

typeof运算符能帮助你识别 symbol 类型

typeof Symbol() === 'symbol'
typeof Symbol('foo') === 'symbol'
typeof Symbol.iterator === 'symbol'

Symbol 类型转换

当使用 symbol 值进行类型转换时需要注意一些事情：

• 尝试将一个 symbol 值转换为一个 number 值时，会抛出一个 TypeError 错误  (e.g. +sym or sym | 0).

• 使用宽松相等时， Object(sym) == sym returns true.

• 这会阻止你从一个 symbol 值隐式地创建一个新的 string 类型的属性名。例如，Symbol("foo") + "bar" 将抛出一个 TypeError (can't convert symbol to string).

• "safer" String(sym) conversion 的作用会像symbol类型调用 Symbol.prototype.toString() 一样，但是注意 new String(sym) 将抛出异常。

Symbols 与 for...in 迭代

Symbols 在 for...in 迭代中不可枚举。另外，Object.getOwnPropertyNames() 不会返回 symbol 对象的属性，但是你能使用 Object.getOwnPropertySymbols() 得到它们。

var obj = {};

obj[Symbol('a')] = 'a';
obj[Symbol.for('b')] = 'b';
obj['c'] = 'c';
obj.d = 'd';

for (var i in obj) {
   console.log(i // logs "c" and "d"
}

Symbols 与 JSON.stringify()

当使用 JSON.strIngify() 时以 symbol 值作为键的属性会被完全忽略：

JSON.stringify{[Symbol('foo')]: 'foo'}                 
// '{}'

更多细节，请看 JSON.stringify()。

Symbol 包装器对象作为属性的键

当一个 Symbol 包装器对象作为一个属性的键时，这个对象将被强制转换为它包装过的 symbol 值：

var sym = Symbol('foo'
var obj = {[sym]: 1};
obj[sym];            // 1
obj[Object(sym)];    // still 1

规范

浏览器兼容性