unique symbol型でイミュータブルを実現する方法について

Question

以下の記事を読んでていきなり”unique symbol”型というところで行き詰まってしまって記事の要点まで行けず困っております

TypeScriptでMapped Typesを使ってきれいなインターフェースを作る話

そもそも”unique symbol”とは？ということで調べますと以下のような要点が得られました

• 「unique symbol」型も Symbol( )で生成する
• 「unique symbol」型はconstまたはstatic readonlyのフィールドでのみ利用可
• 「unique symbol」型同士の変数でも相互代入は不可
• 「unique symbol」型の変数が定義されるとそれが一種の型として定義空間に追加される（const mySym: unique symbol;とあると、一意な mySymという 「ユニークな型」が同時に宣言されるということ）

そしてもっとも知りたいところは、記事内で「イミュータブルなレコード（ImmutableRecord<Data>）を扱うempty関数とset関数を定義する」というくだりで、どうして以下のエイリアスでイミュータブルな型が出来るのかという点です

declare const recordBrand: unique symbol;
type ImmutableRecord<Data> = {
    [recordBrand]: Data
};

これであっても変更は可能と思います。なのでコードの主旨が汲み取れてないなとずっと悩んでおります

let obj: ImmutableRecord<{name: string}> = {
    [recordBrand]: {name: 'Mike'}
}
obj[recordBrand].name = 'John'
console.log(obj[recordBrand].name) // 'John'

質問の要点としては「これはどこがイミュータブルなの？」ということなのですが。

またさらに記事内でこれに続くコードで、関数の実装を書いてみれば何か思いつくかと思いやってみたのですが、ここでも理解不足でset関数の正しい実装がわからず、こちらについても教えていただきたいです。

function empty(): ImmutableRecord<{}>{
    return {[recordBrand]:{}}
}
function set<Data, Key extends string, Value>(
    map: ImmutableRecord<Data>,
    key: Key,
    value: Value,
): ImmutableRecord<Data & {
    [K in Key]: Value
}>{
    map.key = value
　　return map
}
// error message
// Type 'ImmutableRecord<Data>' is not assignable to type 'ImmutableRecord<Data & { [K in Key]: Value; }>'

交差型であればいいのなら単にプロパティーを追加するだけ可と思い上のようにしたのですがこれではだめなのでしょうか？これでどうして返り値の型と一致しないエラーになるのでしょうか？

Answer 1

まずこれのどこがイミュータブルで嬉しいんじゃいという話なんですが

declare const Green: unique symbol;
declare const Yellow: unique symbol;
declare const Red: unique symbol;
type SignalColors = {
    [Green]: void,
    [Yellow]: void,
    [Red]: void,
};

こんな感じで定義してやると Green、Yellow、Red が型レベルで区別できるイミュータブルなラベルに変化します。で、これにはもちろん前述のように値をもたせることもできます。この値はミュータブルですが型はあるのでレコードの型としてはイミュータブルですね。ちなみレコードではなくユニオンですが

declare const Nothing: unique symbol;
declare const Just: unique symbol;
type Maybe<T> = {[Just]: T} | {[Nothing]: void};

function safeDiv(x: number, y:number): Maybe<number> {
  if(y == 0){
    return {[Nothing]: undefined}
  } else {
    return {[Just]: x / y}
  }
}

なんて使い方もできます（実用的かは未知数）。

次に

function empty(): ImmutableRecord<{}>{
    return {[recordBrand]:{}}
}
function set<Data, Key extends string, Value>(
    map: ImmutableRecord<Data>,
    key: Key,
    value: Value,
): ImmutableRecord<Data & {
    [K in Key]: Value
}>{
    map.key = value
　　return map
}
// error message
// Type 'ImmutableRecord<Data>' is not assignable to type 'ImmutableRecord<Data & { [K in Key]: Value; }>'

がなんでダメなんじゃいというお話ですが、map はまだ ImmutableRecord<Data> 型であり key は存在してないので参照しようとすると当然怒られます。ついでにいうと map.key では "key" という名前で参照しようとするので変数を展開せねばならずやるなら map[key] です。しかし前述の通り型が合わないのでアクセスできません。どうするか。一時的にオブジェクトを作ってそこに key と value を詰め込み、{...hoge} をつかって一気にオブジェクトを作り上げるのです。

function set<Data, Key extends string, Value>(
    map: ImmutableRecord<Data>,
    key: Key,
    value: Value,
): ImmutableRecord<Data & {
    [K in Key]: Value
}>{
    let kv = Object()
    kv[key] = value
    return {[recordBrand]:{...map[recordBrand],...kv}}
  }
}

ひょっとしたら Map<K, V>() 使えたかもしれませんが、まあできたことはできました。TypeScript の型は奥が深いですね！楽しみましょー

Comments

[TOMIYASU_chan]

ありがとうございます（確認がすごく遅くなりました）
> 型レベルで区別できるイミュータブルなラベルに変化します
> 値は「ミュータブル」ですが型はあるのでレコードの型としてはイミュータブル
この部分の説明でやっと理解が進みました。またsetの返り値の交差型の部分が実装例でやっとわかりました。自分が使うかどうかはわかりませんが少し理解が深まり嬉しいです