TypeScript Office - Symbols
# Symbols 介绍
从 ECMAScript 2015 开始，symbol 是一种原始的数据类型，就像 number 和 string 一样。
symbol 值是通过调用 Symbol 构造函数创建的。
let sym1 = Symbol();
let sym2 = Symbol("key"); // 可选的字符串 key
2
Symbols 是不可改变的，而且是独一无二的。
let sym2 = Symbol("key");
let sym3 = Symbol("key");
sym2 === sym3; // false, symbols 是唯一的
2
3
就像字符串一样，Symbols 可以被用作对象属性的键。
const sym = Symbol();
let obj = {
[sym]: "value",
};
console.log(obj[sym]); // "value"
2
3
4
5
Symbols 也可以与计算属性声明结合起来，以声明对象属性和类成员。
const getClassNameSymbol = Symbol();
class C {
[getClassNameSymbol]() {
return "C";
}
}
let c = new C();
let className = c[getClassNameSymbol](); // "C"
2
3
4
5
6
7
8
# unique symbol
为了能够将 symbols 作为唯一的字面符号，我们提供了一个特殊的类型 unique symbol。unique symbol 是 symbol 的一个子类型，只在调用 Symbol() 或 Symbol.for() 或明确的类型注释时产生。这种类型只允许在常量声明和只读静态属性中使用，为了引用一个特定的唯一符号，你必须使用 typeof 操作符。每个对唯一符号的引用都意味着一个完全独特的身份，它与一个给定的声明相联系。
declare const sym1: unique symbol;
// sym2 只能是一个常数参考。
let sym2: unique symbol = Symbol();
// Ⓧ 类型为 "唯一符号 "的变量必须是 "const"类型。
// 运行正确--指的是一个独特的 symbol，但其身份与 'sym1' 相联系。
let sym3: typeof sym1 = sym1;
// 也是正确的
class C {
static readonly StaticSymbol: unique symbol = Symbol();
}
2
3
4
5
6
7
8
9
10
因为每个 unique symbol 都有一个完全独立的身份，没有两个 unique symbol 类型是可以相互分配或比较的。
const sym2 = Symbol();
const sym3 = Symbol();
// 这个条件将总是返回 'false'，因为 'typeof sym2' 和 'typeof sym3' 的类型没有重合。
if (sym2 === sym3) {
// ...
}
2
3
4
5
6
# 知名的 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' 环境绑定之外的属性名。