導入

TypeScriptを導入してから、過去のコードの改修の際や過去のプログラムへの新規機能の追加の際に、相対的に安心して作業を行えるようになりました。

しかし、独学の私にとっては学習コストが高く、すぐに書き方のルールを忘れてしまいます。

したがって、すぐに思い出せるように簡単な備忘録を残していきます。

本題

Record<Keys, Type>

TypeScriptにおけるRecordは、あるオブジェクトのプロパティのキーと、そのプロパティの値の型を指定できるユーティリティ型です。

簡単に言うと、「キーと値のペアからなるオブジェクトを型安全に作るための便利なツール」です。

もっとわかりやすくいうと、

Record型は「このオブジェクトのキーはこういう型、値はこういう型だよ」と一括で指定できる便利なツールです。

特定のプロパティ名を使わずに、同じ型のキーと値の組み合わせをたくさん扱いたい場合に特に役立ちます。

これではよくわからないと思うので、私がRecord型を導入した際の実装を参考に（そのままは載せませんが...）例を記載しておきます。

過去の実装

過去に以下のような実装をしていました。

// 各トークンの情報を定義する型
interface TokenInfo {
    TOKEN_ADDR: string;
    UNDERLYING_ADDR: string;
}

interface LendingProtocol_X_Tokens {
    X_DAI: TokenInfo;
    X_WETH: TokenInfo;
    X_USDC: TokenInfo;
    // さらに他のトークンが追加されるたびに増やす...
}

const protocolXTokens: LendingProtocol_X_Tokens = {
    X_DAI: { TOKEN_ADDR: "0x...", UNDERLYING_ADDR: "0x..." },
    X_WETH: { TOKEN_ADDR: "0x...", UNDERLYING_ADDR: "0x..." },
    X_USDC: { TOKEN_ADDR: "0x...", UNDERLYING_ADDR: "0x..." },
    // さらに他のトークンが追加されるたびに増やす...
};

このコードは設定みたいなものです。

よくあるデリバティブ的なプロトコルは皆、

原資産のトークンのアドレスとそれを活用するデリバティブトークンのアドレスを持っています。

したがって、新規のデリバティブトークンが実装され、それに対応する場合、

LendingProtocol_X_Tokensに新規でコードを実装しなければならず、

だるい上、この設定みたいなコードはあまり触らないため忘れがちで、安全性の観点から問題があるなと考えていました。

`Record`型の導入

ここでRecord型を導入しました。

// 各トークンの情報を定義する型
interface TokenInfo {
    TOKEN_ADDR: string;
    UNDERLYING_ADDR: string;
}

// トークン情報を定義
const protocolXTokens: Record<string, TokenInfo> = {
    X_DAI: { TOKEN_ADDR: "0x...", UNDERLYING_ADDR: "0x..." },
    X_WETH: { TOKEN_ADDR: "0x...", UNDERLYING_ADDR: "0x..." },
    X_USDC: { TOKEN_ADDR: "0x...", UNDERLYING_ADDR: "0x..." },
    // 新しいトークンが追加されても型定義は変更しなくてよい
};

こんな感じで、型は触らずに、新規のデリバティブトークンの追加のみで対応できるようになりました。

要するに、動的な変化に型が柔軟に対応できるようになったといえます。