symbol型 (シンボル型)

JavaScriptのsymbol型はプリミティブ型の一種で、その値が一意になる値です。boolean型やnumber型は値が同じであれば、等価比較がtrueになります。一方、シンボルはシンボル名が同じであっても、初期化した場所が違うとfalseになります。

js
const s1 = Symbol("foo");
const s2 = Symbol("foo");
console.log(s1 === s1);
true
console.log(s1 === s2);
false

js
const s1 = Symbol("foo");
const s2 = Symbol("foo");
console.log(s1 === s1);
true
console.log(s1 === s2);
false

Rubyにもシンボルという名前の型があります。Rubyのシンボルは値さえ同じなら、書いてある場所が異なっても等価比較がtrueになります。

ruby
# Rubyコード
s1 = :foo
s2 = :foo
p s1 == s2 #=> true

ruby
# Rubyコード
s1 = :foo
s2 = :foo
p s1 == s2 #=> true

一方、JavaScriptでは前述のとおり、シンボルを初期化した場所で決まるので、Rubyから来た方は注意してください。Rubyのシンボル的なことは、JavaScriptやTypeScriptでは文字列を用いて解決します。

シンボルの型注釈

TypeScriptでシンボルの型注釈はsymbolを用います。

ts
const s: symbol = Symbol();

ts
const s: symbol = Symbol();

symbol型を使う上での注意点

symbol型を直接JSON.stringify()に渡すとundefinedが返ります。

ts
console.log(JSON.stringify(Symbol("many")));
undefined

ts
console.log(JSON.stringify(Symbol("many")));
undefined

また、symbol型をプロパティに含むオブジェクトをJSON.stringify()に渡すと、symbol型をプロパティに含むキーは消滅します。

ts
console.log(
  JSON.stringify({
    x: Symbol("many"),
    y: "hello",
  })
);
{ "y": "hello" }

ts
console.log(
  JSON.stringify({
    x: Symbol("many"),
    y: "hello",
  })
);
{ "y": "hello" }

同様に、symbol型をキーに含むオブジェクトをJSON.stringify()に渡すと、symbol型のキーは消滅します。

ts
console.log(
  JSON.stringify({
    [Symbol("many")]: "hello",
    y: "hello",
  })
);
{ "y": "hello" }

ts
console.log(
  JSON.stringify({
    [Symbol("many")]: "hello",
    y: "hello",
  })
);
{ "y": "hello" }

シンボルの用途

JavaScriptにシンボルが導入された動機は、JavaScriptの組み込みAPIの下位互換性を壊さずに新たなAPIを追加することでした。要するに、JavaScript本体をアップデートしやすくするために導入されたものです。したがって、アプリケーションを開発する場合に限っては、シンボルを駆使してコードを書く機会はそう多くはありません。