TypeScriptの型安全について

前提・実現したいこと

TypeScriptの型について質問です。
オブジェクトのキーに必ずxを持ち、yまたはzいずれかのキーのみが必要な型って可能なんでしょうか？

{ x: string, y: string }または{ x: string, z: string }のみを受け入れ、
{ x: string, y: string, z: string }はエラーとしたいです。

試したこと

Union型で作ってみましたが当然のようにx, y, zを全て持つオブジェクトに対しType Errorが出ませんでした。

該当のソースコード

TypeScript
1type Props = { [key in 'x' | 'y']: string } | { [key in 'x' | 'z']: string };

補足情報（FW/ツールのバージョンなど）

TypeScript 3.7.2

行動規範の内容に同意します

回答1件

ベストアンサー

こんにちは

このご質問と同様の問題に、業務であたったことがあり、そのときは、以下を参考にして切り抜けました。

stackoverflow: [Does Typescript support mutually exclusive types?

](https://stackoverflow.com/questions/42123407/does-typescript-support-mutually-exclusive-types) のこの回答 (by Guilherme Agostinelliさん）

上記を参考にすると、ご質問にある要件を満たす型 Props は以下のように書けます。

Typescript
1type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };
2type XOR<T, U> = (T | U) extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
3
4type PropsY = { x: string, y: string };
5type PropsZ = { x: string, z: string };
6
7type Props = XOR<PropsY, PropsZ>;
8
9const p1: Props = { x: 'hello', y: 'world' }; // OK
10const p2: Props = { x: 'hello', z: 'world' }; // OK
11const p3: Props = { x: 'hello', y: 'world', z: '!' }; // NG

参考になれば幸いです。

投稿2019/11/18 01:29

jun68ykt

総合スコア9058

tutti56

2019/11/18 02:46

ご回答ありがとうございます。希望通りの動きとなりました。 Conditional Types　を使うとは思ってはいたんですが、私の頭ではこれは思いつかないですね。 Without<T, U>　は Mapped Types を利用して Exclude で keyof T, keyof U の共通以外を抽出した新しい型を作成。 XOR<T, U> は Without で作成された型ともう一方の型を Intersection Types で結合した型を作成って感じですかね。間違ってたらすみません。これを機にもっと勉強いたします。今回は本当にありがとうございました。