TypeScript：Symbols

一、简介

自ECMAScript 2015起，symbol成为了一种新的原生类型，就像number和string一样。

symbol类型的值是通过Symbol构造函数创建的。

let sym1 = Symbol();

let sym2 = Symbol("key"); // 可选的字符串key

Symbols是不可改变且唯一的。

let sym2 = Symbol("key"); // 可选的字符串key
// Symbols是不可改变且唯一的。

let sym3 = Symbol("key");

let result = sym2 === sym3; // false, symbols是唯一的
console.log(`result = ${result}`)// result = false

运行结果

像字符串一样，symbols也可以被用做对象属性的键。

let sym5 = Symbol();

let obj5 = {
    [sym5]: "test"
};

console.log(obj5[sym5]); // "test"

运行结果

Symbols也可以与计算出的属性名声明相结合来声明对象的属性和类成员。

const getClassNameSymbol = Symbol();

class C6 {
    [getClassNameSymbol](){
       return "C6";
    }
}

let c6 = new C6();
let className = c6[getClassNameSymbol](); // "C6"
console.log(`className = ${className}`)// className = C6

运行结果

二、众所周知的Symbols

除了用户定义的symbols，还有一些已经众所周知的内置symbols。 内置symbols用来表示语言内部的行为。

以下为这些symbols的列表：

Symbol.hasInstance
方法，会被instanceof运算符调用。构造器对象用来识别一个对象是否是其实例。

Symbol.isConcatSpreadable
布尔值，表示当在一个对象上调用Array.prototype.concat时，这个对象的数组元素是否可展开。

Symbol.iterator
方法，被for-of语句调用。返回对象的默认迭代器。

Symbol.match
方法，被String.prototype.match调用。正则表达式用来匹配字符串。

Symbol.replace
方法，被String.prototype.replace调用。正则表达式用来替换字符串中匹配的子串。

Symbol.search
方法，被String.prototype.search调用。正则表达式返回被匹配部分在字符串中的索引。

Symbol.species
函数值，为一个构造函数。用来创建派生对象。

Symbol.split
方法，被String.prototype.split调用。正则表达式来用分割字符串。

Symbol.toPrimitive
方法，被ToPrimitive抽象操作调用。把对象转换为相应的原始值。

Symbol.toStringTag
方法，被内置方法Object.prototype.toString调用。返回创建对象时默认的字符串描述。

Symbol.unscopables
对象，它自己拥有的属性会被with作用域排除在外。

三、11base.ts代码

// https://www.tslang.cn/docs/handbook/symbols.html Symbols

// symbol类型的值是通过Symbol构造函数创建的。
let sym1 = Symbol();

let sym2 = Symbol("key"); // 可选的字符串key
// Symbols是不可改变且唯一的。

let sym3 = Symbol("key");

let result = sym2 === sym3; // false, symbols是唯一的
console.log(`result = ${result}`)// result = false

// 像字符串一样，symbols也可以被用做对象属性的键。
let sym5 = Symbol();

let obj5 = {
    [sym5]: "test"
};

console.log(obj5[sym5]); // "test"

// Symbols也可以与计算出的属性名声明相结合来声明对象的属性和类成员。
const getClassNameSymbol = Symbol();

class C6 {
    [getClassNameSymbol](){
       return "C6";
    }
}

let c6 = new C6();
let className = c6[getClassNameSymbol](); // "C6"
console.log(`className = ${className}`)// className = C6

四、LearnTypeScript 源码

点击查看LearnTypeScript 源码