TypeSciptである文字列が特定のObject型のkeyに存在しているかを確認したい

Question

やりたいこと

type Hoge = { foo: string, bar: number, baz: string[] }
const value: string = 'foo'

上記の型定義と変数が存在する時、value（string型変数）の内容がHogeのkeyに存在するかを確認したいです。

もう少し具体的にやりたいことを書くと、上記の場合fooはHogeのkeyに存在するのでtrueになり、もしvalueの内容がfuga(Hogeのkeyに存在しない文字列）だった場合はflaseになるような条件分岐を書きたいです。

よろしくお願いします。

追記

上記内容ができないようであれば、何らかの形でkeyの列挙を１箇所にまとめたいです。
もう少し具体定期なコードに落とし込むと

const userPropertys = ['id', 'name']
type User = { id: string; name: string }

const value = 'name'
if (userPropertys.includes(value)) {
  console.log('true')
}

上記のように値で持つことでチェックすることができることは理解しているのですが、例えばここにphone: numberプロパティが追加になった場合にuserPropertysとUser型の２箇所に追加しなければならないことに憤りを感じています。
せめてUser型はuserPropertysの値全てをkeyに持たないとコンパイルエラーとなるとか、userPropertysに列挙された値のみkeyに持てるとか、両者の繋がりを作ることでそういった安全性が欲しいのですが、何か解決手段は無いでしょうか。

追記２

なぜこのようなことをしたいのかについて触れておくと、以下のようなユーザー定義型ガードを実装する上で使用したいからです。

const userPropertys = ['id', 'name', 'phone']
type User = { id: string; name: string; phone: number }

const Func = (value: unknown): value is keyof User => {
  return typeof value === 'string' && userPropertys.includes(value)
}

追記３

const stringKeys = ['name', 'address'] as const
const numberKeys = ['phone'] as const

// 配列の型から値の型を抽出
type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType[number]

type UserString = {
  [k in ArrayElement<typeof stringKeys>]: string
}
type UserNumber = {
  [k in ArrayElement<typeof numberKeys>]: number
}

type User = UserString & UserNumber

const user: User = {
  name: 'hoge',
  address: 'hoge',
  phone: 111,
}

Comments

[BluOxy]

userPropertys は必要なんでしょうか。

[tanana_m]

他の方の回答である通り、型と実行時の値を照合をすることができないので、keyの種類を値で持つならばこうなるかな、というイメージです。

[BluOxy]

照合する必要があるのは、実行時の値の型が判明していないからでしょうか。実行時の値の型が判明しているならわざわざ userPropertys を作らなくても良さそうに思いました

[tanana_m]

具体的なコードがイメージできず、申し訳ないです。
お手数ですがコードを上げていただくことはできるでしょうか。

[BluOxy]

実行時の値の型が判明していないかわかっていないので憶測で書いたソースコードですが、仮に型が判明していないなら下記のようなことをしているのかと思いました。

const user = { id: 3, name: "田中" } : any;
if(userPropertys.includes('name')){
console.log(user.name);
}

[tanana_m]

実現したいことが私の質問意図とは少しずれているようでしたので、具体的にやりたいことをさらに追記しました。
お手数ですがご確認ください。

Answer 1

せめてUser型はuserPropertysの値全てをkeyに持たないとコンパイルエラーとなるとか、userPropertysに列挙された値のみkeyに持てるとか、両者の繋がりを作ることでそういった安全性が欲しい

userPropertys を User を実装したクラスのオブジェクトから生成するようにすればコンパイルエラーを起こすことはできます。

type User = { id: string; name: string }
class UserStub implements User { id = null; name = null; }

type UserKeys = Array<keyof User>;
const userPropertys: UserKeys = Object.keys(new UserStub()) as UserKeys;
console.log(userPropertys); // (2) ['id', 'name']

const value = 'name';
if (userPropertys.includes(value)) {
    console.log('true');
}

上記実装の場合は User のプロパティを消せば userPropertys.includes(value) でエラーが起き、UserStub のプロパティを消せば User を満たさなくなりエラーが起きます。

ユーザー定義型ガードを実装する上で使用したいから

unknown な型を受け取らないように実装できるか検討する方が賢明な気がしています。（背景によると思いますが）
もし実装できるなら userPropertys は必要なくなり、シンプルな実装になるかもしれません。

Comments

[BluOxy]

話が前後しましたが、key の列挙を 1 箇所にまとめる方法は無いと思います。

Answer 2

TypeScriptの型はコンパイル時だけの存在で、実行時には消えてしまうので、型と実行時の値を照合する、ようなことはできません。

実行時に参照したいのであれば、何らかの値として確保しておく必要があります。

---

(追記)

「値が全部同じ型でいい」なら、配列から型を作ることは可能です。

const keys = ["name", "address", "phone"] as const;

// 配列の型から値の型を抽出
type ArrayElement<ArrayType extends readonly unknown[]> = ArrayType[number];

type User = {
  [k in ArrayElement<typeof keys>]: string;
}

Comments

[tanana_m]

ご回答ありがとうございます。
質問内容を追記しましたので、ご確認とご回答をいただきたいです。

[tanana_m]

ご回答ありがとうございます。
全部同じ型ではダメなんですよね…。
そうなるともう諦めて型と配列の２箇所で管理するしかないですかね。

[maisumakun]

> 全部同じ型ではダメなんですよね…。

いちおう、型ごとに分けてUnionすれば作れなくはないですが、見栄えは悪くなりそうです。

[tanana_m]

ご回答ありがとうございます、勉強になります。
自分で書いてみて質問に追記してみたのですが、こんなイメージでしょうか。
認識違いや改善点あれば教えていただきたいです。