メインコンテンツまでスキップ

オブジェクトからプロパティの型を生成する

オブジェクトからプロパティだけ欲しい

📄️ オブジェクトからキーの型を生成する

オブジェクトからキーだけ欲しい

前ページとは対照的にオブジェクトからプロパティだけのユニオン型を得ることを目的とします。今回も前回と同様に次のメッセージが定義されているとします。

ts
const conf = {
en: "Are you sure?",
fr: "Êtes-vous sûr?",
es: "Está seguro?",
ja: "よろしいですか?",
zh: "您确定吗?",
};
ts
const conf = {
en: "Are you sure?",
fr: "Êtes-vous sûr?",
es: "Está seguro?",
ja: "よろしいですか?",
zh: "您确定吗?",
};

最終的には次のようなユニオン型が今回の目的です。

ts
type ConfirmationMessage =
| "Are you sure?"
| "Êtes-vous sûr?"
| "Está seguro?"
| "よろしいですか?"
| "您确定吗?";
ts
type ConfirmationMessage =
| "Are you sure?"
| "Êtes-vous sûr?"
| "Está seguro?"
| "よろしいですか?"
| "您确定吗?";

今回の問題を解くにあたって

今回は今まで紹介してきたオブジェクトから型を作り出す方法と Mapped type の合わせ技で再現することができます。

📄️ オブジェクトから型を生成する

多くの言語では型による構造体、オブジェクトの定義をしてからコーディングが始まりますが、元がJavaScriptであるTypeScriptにはそのような決まりがないことも多々あります。

📄️ オブジェクトからキーの型を生成する

オブジェクトからキーだけ欲しい

アプローチの方法としてはまずオブジェクトからキーの型を生成し Mapped type を使いオブジェクトのプロパティの型を参照、それらをリテラル型で取得します。

キーの型を生成する

キーの型の生成は前のページにあるものと同一です。次のようにすることでキーである言語のユニオン型を取得できます。詳細についてはオブジェクトからキーの値を生成するのページをご覧ください。

📄️ オブジェクトからキーの型を生成する

オブジェクトからキーだけ欲しい
ts
type Language = keyof typeof conf;
type Language = "en" | "fr" | "es" | "ja" | "zh"
ts
type Language = keyof typeof conf;
type Language = "en" | "fr" | "es" | "ja" | "zh"

Mapped type

オブジェクトのプロパティの型を参照するために Mapped type を使います。そのとき元のオブジェクトから型を生成するためにtypeofを使います。

ts
type ConfirmationMessage = typeof conf[Language];
type ConfirmationMessage = string
ts
type ConfirmationMessage = typeof conf[Language];
type ConfirmationMessage = string

リテラル型を取得するできるようにする

このままだとオブジェクトから型を生成すると同じように型はリテラル型ではありません。つまりただのstring型のユニオン型つまりstring型です。そこで、元のオブジェクトconfas constをつけます。

ts
const conf = {
en: "Are you sure?",
fr: "Êtes-vous sûr?",
es: "Está seguro?",
ja: "よろしいですか?",
zh: "您确定吗?",
} as const;
ts
const conf = {
en: "Are you sure?",
fr: "Êtes-vous sûr?",
es: "Está seguro?",
ja: "よろしいですか?",
zh: "您确定吗?",
} as const;

まとめ

お好みで定義したキーの型Languageを Mapped type のキーの部分に代入します。最終的な形は次のようになります。

ts
const conf = {
en: "Are you sure?",
fr: "Êtes-vous sûr?",
es: "está seguro?",
ja: "よろしいですか?",
zh: "您确定吗?",
} as const;
 
type ConfirmationMessage = typeof conf[keyof typeof conf];
type ConfirmationMessage = "Are you sure?" | "Êtes-vous sûr?" | "está seguro?" | "よろしいですか?" | "您确定吗?"
ts
const conf = {
en: "Are you sure?",
fr: "Êtes-vous sûr?",
es: "está seguro?",
ja: "よろしいですか?",
zh: "您确定吗?",
} as const;
 
type ConfirmationMessage = typeof conf[keyof typeof conf];
type ConfirmationMessage = "Are you sure?" | "Êtes-vous sûr?" | "está seguro?" | "よろしいですか?" | "您确定吗?"

as constを忘れないようにしてください。

  • 質問する ─ 読んでも分からなかったこと、TypeScriptで分からないこと、お気軽にGitHubまで🙂
  • 問題を報告する ─ 文章やサンプルコードなどの誤植はお知らせください。