Skip to content

Commit

Permalink
docs(symbol): edit text
Browse files Browse the repository at this point in the history
  • Loading branch information
ruanyf committed Aug 8, 2022
1 parent 686fcff commit 21edbe4
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions docs/symbol.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

ES5 的对象属性名都是字符串,这容易造成属性名的冲突。比如,你使用了一个他人提供的对象,但又想为这个对象添加新的方法(mixin 模式),新方法的名字就有可能与现有方法产生冲突。如果有一种机制,保证每个属性的名字都是独一无二的就好了,这样就从根本上防止属性名的冲突。这就是 ES6 引入`Symbol`的原因。

ES6 引入了一种新的原始数据类型`Symbol`,表示独一无二的值。它属于 JavaScript 语言的数据类型之一,其他数据类型是:`undefined``null`、布尔值(Boolean)、字符串(String)、数值(Number)、大整数(BigInt)、对象(Object)。
ES6 引入了一种新的原始数据类型`Symbol`,表示独一无二的值。它属于 JavaScript 语言的原生数据类型之一,其他数据类型是:`undefined``null`、布尔值(Boolean)、字符串(String)、数值(Number)、大整数(BigInt)、对象(Object)。

Symbol 值通过`Symbol()`函数生成。这就是说,对象的属性名现在可以有两种类型,一种是原来就有的字符串,另一种就是新增的 Symbol 类型。凡是属性名属于 Symbol 类型,就都是独一无二的,可以保证不会与其他属性名产生冲突。

Expand All @@ -17,9 +17,9 @@ typeof s

上面代码中,变量`s`就是一个独一无二的值。`typeof`运算符的结果,表明变量`s`是 Symbol 数据类型,而不是字符串之类的其他类型。

注意,`Symbol`函数前不能使用`new`命令,否则会报错。这是因为生成的 Symbol 是一个原始类型的值,不是对象。也就是说,由于 Symbol 值不是对象,所以不能添加属性。基本上,它是一种类似于字符串的数据类型。
注意,`Symbol()`函数前不能使用`new`命令,否则会报错。这是因为生成的 Symbol 是一个原始类型的值,不是对象,所以不能使用`new`命令来调用。另外,由于 Symbol 值不是对象,所以也不能添加属性。基本上,它是一种类似于字符串的数据类型。

`Symbol`函数可以接受一个字符串作为参数,表示对 Symbol 实例的描述,主要是为了在控制台显示,或者转为字符串时,比较容易区分。
`Symbol()`函数可以接受一个字符串作为参数,表示对 Symbol 实例的描述。这主要是为了在控制台显示,或者转为字符串时,比较容易区分。

```javascript
let s1 = Symbol('foo');
Expand All @@ -34,7 +34,7 @@ s2.toString() // "Symbol(bar)"

上面代码中,`s1``s2`是两个 Symbol 值。如果不加参数,它们在控制台的输出都是`Symbol()`,不利于区分。有了参数以后,就等于为它们加上了描述,输出的时候就能够分清,到底是哪一个值。

如果 Symbol 的参数是一个对象,就会调用该对象的`toString`方法,将其转为字符串,然后才生成一个 Symbol 值。
如果 Symbol 的参数是一个对象,就会调用该对象的`toString()`方法,将其转为字符串,然后才生成一个 Symbol 值。

```javascript
const obj = {
Expand All @@ -46,7 +46,7 @@ const sym = Symbol(obj);
sym // Symbol(abc)
```

注意,`Symbol`函数的参数只是表示对当前 Symbol 值的描述,因此相同参数的`Symbol`函数的返回值是不相等的。
注意,`Symbol()`函数的参数只是表示对当前 Symbol 值的描述,因此相同参数的`Symbol`函数的返回值是不相等的。

```javascript
// 没有参数的情况
Expand All @@ -62,7 +62,7 @@ let s2 = Symbol('foo');
s1 === s2 // false
```

上面代码中,`s1``s2`都是`Symbol`函数的返回值,而且参数相同,但是它们是不相等的。
上面代码中,`s1``s2`都是`Symbol()`函数的返回值,而且参数相同,但是它们是不相等的。事实上,如果调用100次`Symbol()`,会得到100个互不相等的值

Symbol 值不能与其他类型的值进行运算,会报错。

Expand Down Expand Up @@ -101,13 +101,13 @@ sym + 2 // TypeError

## Symbol.prototype.description

创建 Symbol 的时候,可以添加一个描述
前面说过,`Symbol()`函数创建 Symbol 值时,可以用参数添加一个描述

```javascript
const sym = Symbol('foo');
```

上面代码中,`sym`的描述就是字符串`foo`
上面代码中,`sym`这个值的描述就是字符串`foo`

但是,读取这个描述需要将 Symbol 显式转为字符串,即下面的写法。

Expand All @@ -118,7 +118,7 @@ String(sym) // "Symbol(foo)"
sym.toString() // "Symbol(foo)"
```

上面的用法不是很方便。[ES2019](https://github.com/tc39/proposal-Symbol-description) 提供了一个实例属性`description`,直接返回 Symbol 的描述
上面的用法不是很方便。[ES2019](https://github.com/tc39/proposal-Symbol-description) 提供了一个 Symbol 值的实例属性`description`,直接返回 Symbol 值的描述

```javascript
const sym = Symbol('foo');
Expand All @@ -128,7 +128,7 @@ sym.description // "foo"

## 作为属性名的 Symbol

由于每一个 Symbol 值都是不相等的,这意味着 Symbol 值可以作为标识符,用于对象的属性名,就能保证不会出现同名的属性。这对于一个对象由多个模块构成的情况非常有用,能防止某一个键被不小心改写或覆盖。
由于每一个 Symbol 值都是不相等的,这意味着只要 Symbol 值作为标识符,用于对象的属性名,就能保证不会出现同名的属性。这对于一个对象由多个模块构成的情况非常有用,能防止某一个键被不小心改写或覆盖。

```javascript
let mySymbol = Symbol();
Expand All @@ -150,7 +150,7 @@ Object.defineProperty(a, mySymbol, { value: 'Hello!' });
a[mySymbol] // "Hello!"
```

上面代码通过方括号结构和`Object.defineProperty`,将对象的属性名指定为一个 Symbol 值。
上面代码通过方括号结构和`Object.defineProperty()`方法,将对象的属性名指定为一个 Symbol 值。

注意,Symbol 值作为对象属性名时,不能用点运算符。

Expand Down Expand Up @@ -280,7 +280,7 @@ const shapeType = {

## 属性名的遍历

Symbol 作为属性名,遍历对象的时候,该属性不会出现在`for...in``for...of`循环中,也不会被`Object.keys()``Object.getOwnPropertyNames()``JSON.stringify()`返回。
Symbol 值作为属性名,遍历对象的时候,该属性不会出现在`for...in``for...of`循环中,也不会被`Object.keys()``Object.getOwnPropertyNames()``JSON.stringify()`返回。

但是,它也不是私有属性,有一个`Object.getOwnPropertySymbols()`方法,可以获取指定对象的所有 Symbol 属性名。该方法返回一个数组,成员是当前对象的所有用作属性名的 Symbol 值。

Expand Down

0 comments on commit 21edbe4

Please sign in to comment.