TypeScript：型から特定のプロパティを除去する2つの方法 - ExcludeとOmitの比較と使い分け

2024-06-20

TypeScriptにおける「Exclude」と「Omit」は、どちらも型から特定のプロパティを除去するためのジェネリック型ですが、それぞれ異なる用途と動作を持ちます。この記事では、それぞれの型とその違いを分かりやすく解説します。

Exclude

「Exclude」は、型連合から特定の型を除外するための型です。構文は以下の通りです。

Exclude<T, U>

ここで、

T は、型連合を表す型パラメータです。
U は、T から除外する型を表す型パラメータです。

例

type User = { id: number; name: string; age: number };
type PartialUser = { id: number; name: string };

// PartialUser から age プロパティを除外した型を定義
type UserWithoutAge = Exclude<User, PartialUser>;

この例では、UserWithoutAge 型は id と name プロパティのみを持つ型となります。

Omit

「Omit」は、オブジェクト型またはインターフェースから特定のプロパティを除去するための型です。構文は以下の通りです。

Omit<T, K extends keyof T>

T は、オブジェクト型またはインターフェースを表す型パラメータです。

type User = { id: number; name: string; age: number };

// User から age プロパティを除外した型を定義
type UserWithoutAge = Omit<User, 'age'>;

違い

「Exclude」と「Omit」の主な違いは以下の通りです。

使用できる型:
- Exclude: 型連合のみで使用できます。
- Omit: オブジェクト型またはインターフェースのみで使用できます。
除外するプロパティの指定方法:
- Exclude: 除外する型を直接指定します。
- Omit: 除外するプロパティの名前を文字列として指定します。

型連合から特定の型を除去したい場合は Exclude を使用します。
オブジェクト型またはインターフェースから特定のプロパティを除去したい場合は Omit を使用します。

排除する型が既知の場合

この場合は、Exclude を使用するのが一般的です。

type User = { id: number; name: string; age: number };
type PartialUser = { id: number; name: string };

type UserWithoutAge = Exclude<User, PartialUser>; // { id: number; name: string; }

const userWithoutAge: UserWithoutAge = {
  id: 1,
  name: 'Taro Yamada'
};

console.log(userWithoutAge.age); // エラー: 'age' プロパティは 'UserWithoutAge' 型に存在しません

説明

この例では、UserWithoutAge 型は User 型から PartialUser 型のすべてのプロパティを除外した型として定義されています。

そのため、userWithoutAge オブジェクトには id と name プロパティのみが存在し、age プロパティにアクセスしようとするとエラーが発生します。

除外するプロパティ名が既知の場合

type User = { id: number; name: string; age: number };

type UserWithoutAge = Omit<User, 'age'>; // { id: number; name: string; }

const userWithoutAge: UserWithoutAge = {
  id: 1,
  name: 'Taro Yamada'
};

console.log(userWithoutAge.age); // エラー: 'age' プロパティは 'UserWithoutAge' 型に存在しません

型連合とオブジェクト型の両方で利用する

Exclude と Omit を組み合わせることで、より複雑な型の操作を行うことができます。

type User = { id: number; name: string; age: number };
type PartialUser = { id: number; name: string };
type OptionalUser = Partial<User>;

type UserWithoutAgeOrId = Exclude<User, PartialUser>; // { name: string; age: number }
type UserWithOptionalId = Omit<UserWithoutAgeOrId, 'name'>; // { age: number }

const userWithOptionalId: UserWithOptionalId = {
  age: 30
};

console.log(userWithOptionalId.id); // エラー: 'id' プロパティは 'UserWithOptionalId' 型に存在しません
console.log(userWithOptionalId.name); // エラー: 'name' プロパティは 'UserWithOptionalId' 型に存在しません

次に、UserWithOptionalId 型を UserWithoutAgeOrId 型から 'name' プロパティを除外した型として定義します。

本記事では、TypeScriptにおける Exclude と Omit の違いと、それぞれの具体的な使い方について説明しました。

これらの型を理解することで、より柔軟で安全な TypeScript コードを書くことができます。

TypeScriptで「Exclude」と「Omit」以外の方法でプロパティを除去する方法

Pick 型と keyof 演算子を使用して、特定のプロパティのみを含む新しい型を定義できます。この方法は、除外するプロパティが少数の場合に有効です。

type User = { id: number; name: string; age: number };

type UserWithoutAge = Pick<User, keyof User & Exclude<keyof User, 'age'>>; // { id: number; name: string; }

const userWithoutAge: UserWithoutAge = {
  id: 1,
  name: 'Taro Yamada'
};

console.log(userWithoutAge.age); // エラー: 'age' プロパティは 'UserWithoutAge' 型に存在しません

ジェネリック型を使用して、カスタム型ガードを作成し、特定のプロパティが存在しないことを確認できます。この方法は、より複雑なロジックが必要な場合に役立ちます。

type User = { id: number; name: string; age: number };

type WithoutAge<T> = { [P in keyof T]: T[P] extends { age?: never } ? T[P] : never };

type UserWithoutAge = WithoutAge<User>; // { id: number; name: string; }

const userWithoutAge: UserWithoutAge = {
  id: 1,
  name: 'Taro Yamada'
};

console.log(userWithoutAge.age); // エラー: 'age' プロパティは 'UserWithoutAge' 型に存在しません

Intersection タイプと Partial タイプを使用して、既存の型のプロパティをオプションにし、その後、Omit を使用して不要なプロパティを削除できます。この方法は、既存の型の変更を最小限に抑えたい場合に役立ちます。

type User = { id: number; name: string; age: number };

type PartialUser = Partial<User>;

type UserWithoutAge = Omit<PartialUser, 'age'>; // { id?: number; name?: string; }

const userWithoutAge: UserWithoutAge = {
  id: 1,
  name: 'Taro Yamada'
};

console.log(userWithoutAge.age); // undefined

型エイリアス

単純なケースでは、単なる型エイリアスを使用して、新しい型を定義することができます。この方法は、読みやすく、メンテナンスしやすいコードを作成する場合に役立ちます。

type User = { id: number; name: string; age: number };

type UserWithoutAge = { id: number; name: string }; // 明示的に 'age' プロパティを省略

const userWithoutAge: UserWithoutAge = {
  id: 1,
  name: 'Taro Yamada'
};

console.log(userWithoutAge.age); // エラー: 'age' プロパティは 'UserWithoutAge' 型に存在しません