Programming Field

定義済みシンボルの利用

「Symbol」のオブジェクトにはいくつかのプロパティー(「Symbol」クラスとしてのスタティックフィールド)が存在します。これらはプロパティーのキーとして利用することで、ECMAScript準拠の処理においてスクリプトエンジン既定の処理を上書きしたり、独自の処理を与えることでクラスやオブジェクトの利便性を高めたりすることが出来ます。

例えば「Symbol.iterator」は以下のように利用することができます。

/// <reference lib='es2015.iterable' />

// 「Symbol.iterator」をサポートするクラス
class MyIterable {
    constructor(public count: number) { }

    // Iterator オブジェクトを返すメソッド
    public [Symbol.iterator](): Iterator<number> {
        const count = this.count;
        const iter = {
            _index: 0,
            // next メソッドは「done」と「value」を持つオブジェクト(IteratorResult オブジェクト)を返す
            next() {
                const i = this._index;
                if (i < count) {
                    ++this._index;
                    return { value: i, done: false };
                } else {
                    return { value: -1, done: true };
                }
            }
        };
        return iter;
    }
}

const m = new MyIterable(10);
// 「Symbol.iterator」をサポートするので for...of が使える
// ※ 「target」が「es5」以下の場合「downlevelIteration」の有効化が必要
for (const x of m) { // (x は自動で number 型となる)
    console.log(x);  // 順に「0」「1」「2」...「9」を出力
}

※ 「target: 'es5'」以下で「downlevelIteration: true」とするとJavaScriptではPolyfillコードが生成されますが、「target: 'es2015'」でコンパイルするとほぼそのままのコードが出力され、それを実行すると独自の「Symbol.iterator」定義がスクリプトエンジンから呼び出されて適切にfor...ofが実行されることが分かります。

unique symbol

[参考: TypeScript PR #15473]

symbol 型のデータは基本的には「不変なデータ」という扱いであり、ユニーク性(一意性)を保障したい場合に有用なデータです。

「Symbol」を関数として呼び出した場合のデータは常にユニークであるため、

const mySym1 = Symbol('mySym1');

という形で「mySym」変数を作った場合、mySym1 === someVar が true になる someVar の値は「mySym1」の値のみになります。(mySym1 === Symbol('mySym1') は false になります。)

一方、「Symbol.for」を使って取得した symbol データは、引数の文字列が一致すれば同一の symbol データとなりますが、それでも別の文字列であれば不一致となるため、ほぼユニーク性のある symbol データとして用いることができます。

const mySym2 = Symbol.for('mySym2');
console.log(mySym2 === Symbol.for('mySym2')); // true

※ Symbol.for はスクリプトエンジン内部に1つのみ存在する「グローバルsymbolレジストリ」に文字列と symbol データのペアを保持します。そのため、同一環境上では異なるスクリプトファイルでも同じ名前を共有できます。

また、symbol 型では「ユニークなシンボルである」ということを表すために unique symbol という特別な型を利用することができます。

const mySym1: unique symbol = Symbol('mySym1');

※ 「Symbol(...)」および「Symbol.for(...)」で代入される const / readonly な値は自動的に「unique symbol」と扱われるため、上記では「unique symbol」という型指定は省略できます。

このとき、「mySym1」の型は symbol 型を特殊化した「typeof mySym1」というユニークな型になります。ユニークな型であるため、「symbol 型」の変数に「typeof mySym1 型」の値は代入できますが、「typeof mySym1 型」の変数に「symbol 型」の値を代入することは出来ません。

const someSym1: symbol = mySym1;                   // OK
const someSym2: typeof mySym1 = Symbol('mySym1');  // ERROR: TS2322

このことは、特定のシンボルをプロパティーのキーとしてユニークに利用するために非常に有用であり、インターフェイス定義や型推論で役に立ちます。

const mySym1: unique symbol = Symbol('mySym1');
// const で定義された symbol 型変数に「Symbol(...)」または「Symbol.for(...)」の値を代入すると自動的に unique symbol として扱われる
const mySym2 = Symbol.for('mySym2');
// 「Symbol(...)」や「Symbol.for(...)」を使わない場合は普通の symbol として扱われる
const otherSym1 = mySym1;

// プロパティー名(プロパティーシンボル)として型定義に使う場合の例
interface SomeStruct {
    [mySym1]: string;     // OK
    [mySym2]: number;     // OK
    [otherSym1]: object;  // ERROR: TS1169 (プロパティー名に式を入れる場合は結果の型が文字列リテラル型または「unique symbol」でなければならない)
    [key: string]: any;
}

// プロパティー名(プロパティーシンボル)から型推論をする例
declare var someObj: SomeStruct;
const x = someObj[mySym1];     // x は string 型
const z = someObj[otherSym1];  // ERROR: TS2538 ('otherSym1' をインデックス値として使用できない)