Well-Known Symbols は、JavaScriptの仕様（ECMAScript）において、特定のアルゴリズムや動作をカスタマイズするために使用される組み込みの Symbol 値です。これらは、オブジェクトのプロパティキーとして使用され、言語の標準的な動作を拡張または変更するための「フック」として機能します。

Well-Known Symbols はすべてのレルム（実行環境）で共有されます。つまり、異なる実行環境（例えば、異なるiframeやWorker）間でも同じ Symbol 値が使用されます。

Well-Known Symbols の一覧

以下の表は、仕様書で定義されている Well-Known Symbols の一覧です。各シンボルは、特定の目的や動作をカスタマイズするために使用されます。

各 Well-Known Symbol の詳細

1. Symbol.asyncIterator
   • 非同期イテレータを返すメソッドを定義します。for-await-of ループで使用されます。
   • 例:

   const asyncIterable = {
     [Symbol.asyncIterator]: async function* () {
       yield "Hello";
       yield "World";
     }
   };
   
   (async () => {
     for await (const value of asyncIterable) {
       console.log(value); // "Hello", "World"
     }
   })();
   

2. Symbol.hasInstance
   • instanceof 演算子の動作をカスタマイズします。
   • 例:

   class MyClass {
     static [instance Symbol.hasInstance] {
       return Array.isArray(instance);
     }
   }
   
   console.log([] instanceof MyClass); // true
   

3. Symbol.isConcatSpreadable
   • Array.prototype.concat でオブジェクトが展開されるかどうかを制御します。
   • 例:

   const arr = [1, 2];
   arr[Symbol.isConcatSpreadable] = false;
   console.log([].concat(arr)); // [[1, 2]]
   

4. Symbol.iterator
   • イテレータを返すメソッドを定義します。for-of ループで使用されます。
   • 例:

   const iterable = {
     [Symbol.iterator]: function* () {
       yield 1;
       yield 2;
       yield 3;
     }
   };
   
   for (const value of iterable) {
     console.log(value); // 1, 2, 3
   }
   

5. Symbol.match
   • String.prototype.match の動作をカスタマイズします。
   • 例:

   const customMatcher = {
     [str Symbol.match] {
       return str.includes("custom");
     }
   };
   
   console.log("This is a custom string".match(customMatcher)); // true
   

6. Symbol.matchAll
   • String.prototype.matchAll の動作をカスタマイズします。
   • 例:

   const customMatcher = {
     [str Symbol.matchAll] {
       return str.match(/c/g);
     }
   };
   
   console.log([..."custom".matchAll(customMatcher)]); // ["c"]
   

7. Symbol.replace
   • String.prototype.replace の動作をカスタマイズします。
   • 例:

   const customReplacer = {
     [str, replacement Symbol.replace] {
       return str.split(" ").join(replacement);
     }
   };
   
   console.log("Hello world".replace(customReplacer, "-")); // "Hello-world"
   

8. Symbol.search
   • String.prototype.search の動作をカスタマイズします。
   • 例:

   const customSearcher = {
     [str Symbol.search] {
       return str.indexOf("custom");
     }
   };
   
   console.log("This is a custom string".search(customSearcher)); // 10
   

9. Symbol.species
   • 派生オブジェクトを作成するためのコンストラクタを指定します。
   • 例:

   class MyArray extends Array {
     static get [Symbol.species]() {
       return Array;
     }
   }
   
   const myArray = new MyArray(1, 2, 3);
   const mappedArray = myArray.map(x => x * 2);
   
   console.log(mappedArray instanceof MyArray); // false
   console.log(mappedArray instanceof Array); // true
   

10. Symbol.split
    • String.prototype.split の動作をカスタマイズします。
    • 例:

     const customSplitter = {
       [str Symbol.split] {
         return str.split(" ");
       }
     };
    
     console.log("Hello world".split(customSplitter)); // ["Hello", "world"]
    

11. Symbol.toPrimitive
    • オブジェクトをプリミティブ値に変換する動作をカスタマイズします。
    • 例:

     const obj = {
       [hint Symbol.toPrimitive] {
         if (hint === "number") {
           return 42;
         }
         if (hint === "string") {
           return "forty-two";
         }
         return true;
       }
     };
    
     console.log(+obj); // 42
     console.log(`${obj}`); // "forty-two"
     console.log(obj == true); // true
    

12. Symbol.toStringTag
    • オブジェクトのデフォルトの文字列表現をカスタマイズします。
    • 例:

     const obj = {
       [Symbol.toStringTag]: "MyObject"
     };
    
     console.log(obj.toString()); // [object MyObject]
    

13. Symbol.unscopables
    • with ステートメントの環境バインディングから除外するプロパティを指定します。
    • 例:

     const obj = {
       foo: 1,
       bar: 2,
       [Symbol.unscopables]: {
         foo: true
       }
     };
    
     with (obj) {
       console.log(bar); // 2
       console.log(foo); // ReferenceError: foo is not defined
     }
    

歴史

Well-Known Symbols は、JavaScript（ECMAScript）の進化とともに導入され、言語の拡張性と柔軟性を高めるために重要な役割を果たしてきました。その歴史は、主に ECMAScript のバージョンアップに伴って進化してきました。以下に、Well-Known Symbols の歴史をまとめます。

まとめ

Well-Known Symbols は、JavaScriptの標準的な動作をカスタマイズするための強力なツールです。これらを使用することで、オブジェクトの振る舞いを柔軟に変更したり、特定の操作をフックしたりすることができます。各シンボルは、特定の目的に特化しており、言語の拡張性を高める役割を果たしています。

外部リンク

• ECMA-262::6.1.5.1 Well-Known Symbols