TypeScriptのあれこれ⑦ 型の特定のプロパティだけ必須化したい！

1 はじめに
2 指定したプロパティを必須にするユーティリティ型を作成
3 null許容も除外したい場合
4 まとめ
5 おわりに

はじめに

皆さんこんにちは。エンジニアの細川です。

皆さんはTypeScriptで開発を行っていたときに、型の特定のプロパティだけ必須にしたいと思ったことはありませんか？

例えば以下のようなHuman型を考えてみます。

type Human = {
	name: string;
	age: number;
	phoneNumber?: number
	email?: string;
}

このHuman型のphoneNumberを必須にした型をが欲しいときに、いちいち以下のように全プロパティを定義しなおすのは面倒です。

type HumanRequiredPhoneNumber = {
	name: string;
	age: number;
	phoneNumber: number
	email?: string;
}

このような場合に利用できるUtility型の作り方を紹介します。

指定したプロパティを必須にするユーティリティ型を作成

ある型の特定のプロパティを必須にするには以下のようなユーティリティ型を用意します。

/**
* Tのうち、Kで指定されたプロパティを必須にする
*/
type MakeRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;

使い方は以下の通りです。

先ほどと同じようにHuman型のphoneNumberを必須にしたい場合は以下のように書きます。

type HumanRequiredPhoneNumber = MakeRequired<Human, "phoneNumber">

このように第1引数に型名、第2引数に必須化したいプロパティ名を書くことで、以下のようにphoneNumberが必須になっていることを確認できます。

また、emailも必須にしたい場合は以下のように定義すればOKです。

type HumanRequired = MakeRequired<Human, "phoneNumber" | "email">

こうすると、phoneNumberに加えてemailも必須にすることができます。

null許容も除外したい場合

上記の型を利用すればoptionalなプロパティを必須にできるのですが、場合によってはnull許容のプロパティを必須にしたい場合もあるかと思います。

以下のようなHuman型からHumanRequiredNotNull型を作るような場合を考えます。

type Human = {
  name: string;
  age: number;
  phoneNumber?: number | null;
  email?: string | null;
}

↓

type HumanRequiredNotNull = {
  name: string;
  age: number;
  phoneNumber: number;
  email: string
}

この場合は以下のようなユーティリティ型を用意します。

/**
 * Tのうち、Kで指定されたプロパティを必須にし、nullを除去する
 */
type MakeRequiredNonNullable<T, K extends keyof T> = Omit<T, K> & Required<{ [P in K]: NonNullable<T[P]> }>;

使い方は先ほどと同様に一つもしくは複数のプロパティを指定して、必須かつnull許容では無いプロパティにすることができます。

type HumanRequiredNotNull = MakeRequiredNonNullable<Human, "phoneNumber" | "email">

実装してみると以下のようにエラーが出るようになります。

まとめ

オプショナルなプロパティを必須にしたい場合は以下

/**
 * Tのうち、Kで指定されたプロパティを必須にする
 */
type MakeRequired<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;

// 利用する場合
type HumanRequired = MakeRequired<Human, "phoneNumber" | "email">
const taro: HumanRequired = {
	name: "taro",
	age: 20,
	phoneNumber: 00000000000,
	email: "xxx@xxx.com"
}

null許容かつオプショナルなプロパティを必須にし、nullを除外したい場合は以下

/**
 * Tのうち、Kで指定されたプロパティを必須にし、nullを除去する
 */
type MakeRequiredNonNullable<T, K extends keyof T> = Omit<T, K> & Required<{ [P in K]: NonNullable<T[P]> }>;


// 利用する場合
type HumanRequiredNotNull = MakeRequiredNonNullable<Human, "phoneNumber" | "email">
const taro: HumanRequiredNotNull = {
  name: "taro",
  age: 20,
  phoneNumber: 00000000000,
	email: "xxx@xxx.com"
}