TypeScript: 型推論を極める！Omit型とDistributiveOmit型で実現する高度な型操作
2024-06-13
TypeScript: ユニオン型からプロパティを省略し、構造を保持する方法
Omit 型による単一プロパティの省略
まず、Omit 型は、単一のプロパティを特定の型から削除するための型エイリアスです。構文は以下の通りです。
type Omit<T, K extends keyof T> = {
[P in keyof T]: P extends K ? never : T[P];
};
ここで、T は対象となる型、K は削除したいプロパティのキーを表します。
例として、以下のインターフェースから age プロパティを削除してみましょう。
interface User {
id: number;
name: string;
age: number;
}
interface Admin {
id: number;
name: string;
role: string;
}
type UserOrAdmin = User | Admin;
この場合、Omit 型を用いて age プロパティを削除した新しい型を定義できます。
type UserWithoutAge = Omit<User, 'age'>;
type AdminWithoutAge = Omit<Admin, 'age'>;
type UserOrAdminWithoutAge = UserWithoutAge | AdminWithoutAge;
UserOrAdminWithoutAge 型は、User または Admin インターフェースのいずれかから age プロパティを削除した構造を持つオブジェクトを表します。
DistributiveOmit 型による複数プロパティの省略
一方、DistributiveOmit 型は、ユニオン型内のすべての構成要素から特定のプロパティを削除するための型エイリアスです。これは、Omit 型とは異なり、複数のプロパティを同時に削除することができます。
DistributiveOmit 型は、以下のユーティリティ型を用いて定義できます。
type DistributiveOmit<T, K extends keyof any> = T extends any ? Omit<T, K> : never;
この型は、T が任意の型である場合に限り、Omit<T, K> を返します。つまり、T がユニオン型である場合、その各構成要素に対して Omit 型を適用し、結果をユニオン型として返します。
例として、UserOrAdmin 型から age と role プロパティを同時に削除してみましょう。
type UserOrAdminWithoutAgeAndRole = DistributiveOmit<UserOrAdmin, 'age' | 'role'>;
Omit 型と DistributiveOmit 型は、TypeScript においてユニオン型からプロパティを効率的に省略するための便利な型エイリアスです。これらの型を活用することで、コードの可読性と保守性を向上させることができます。
補足
DistributiveOmit型は、TypeScript 4.1 以降で使用可能です。古いバージョンの TypeScript では、以下の代替手段を用いることができます。
type DistributiveOmit<T, K extends keyof any> = {
[P in keyof T]: P extends K ? never : T[P];
}[keyof T];
- より複雑な条件に基づいてプロパティを省略したい場合は、ジェネリック型や条件型を用いることもできます。
Omit 型による単一プロパティの省略
interface User {
id: number;
name: string;
age: number;
}
interface Admin {
id: number;
name: string;
role: string;
}
type UserOrAdmin = User | Admin;
type UserWithoutAge = Omit<User, 'age'>; // { id: number; name: string; }
type AdminWithoutAge = Omit<Admin, 'age'>; // { id: number; name: string; role: string; }
type UserOrAdminWithoutAge = UserWithoutAge | AdminWithoutAge; // { id: number; name: string; } | { id: number; name: string; role: string; }
DistributiveOmit 型による複数プロパティの省略
interface User {
id: number;
name: string;
age: number;
}
interface Admin {
id: number;
name: string;
role: string;
}
type UserOrAdmin = User | Admin;
type UserOrAdminWithoutAgeAndRole = DistributiveOmit<UserOrAdmin, 'age' | 'role'>; // { id: number; name: string; }
ジェネリック型を用いた条件付きプロパティ省略
type ConditionalOmit<T, K extends keyof any, Condition extends boolean> = {
[P in keyof T]: P extends K ? Condition extends true ? never : T[P] : T[P];
};
interface User {
id: number;
name: string;
age: number;
isStudent: boolean;
}
interface Admin {
id: number;
name: string;
role: string;
isManager: boolean;
}
type UserOrAdmin = User | Admin;
type UserWithoutAgeIfStudent = ConditionalOmit<User, 'age', User['isStudent']>; // { id: number; name: string; age?: number; isStudent: boolean; }
type AdminWithoutRoleIfManager = ConditionalOmit<Admin, 'role', Admin['isManager']>; // { id: number; name: string; role?: string; isManager: boolean; }
type UserOrAdminWithoutAgeOrRole = UserWithoutAgeIfStudent | AdminWithoutRoleIfManager; // { id: number; name: string; age?: number; isStudent: boolean; } | { id: number; name: string; role?: string; isManager: boolean; }
これらのサンプルコードは、Omit 型と DistributiveOmit 型の使用方法を理解するのに役立つでしょう。
TypeScript でユニオン型からプロパティを省略するその他の方法
型ガードを使用して、特定のプロパティが存在しないことを確認し、そのプロパティを含むオブジェクト型を除外することができます。
type User = {
id: number;
name: string;
age: number;
};
interface Admin {
id: number;
name: string;
role: string;
}
type UserOrAdmin = User | Admin;
function isUserWithoutAge(obj: UserOrAdmin): obj is UserWithoutAge {
return !('age' in obj);
}
function isAdminWithoutRole(obj: UserOrAdmin): obj is AdminWithoutRole {
return !('role' in obj);
}
type UserWithoutAge = UserOrAdmin extends User ? Omit<User, 'age'> : never;
type AdminWithoutRole = UserOrAdmin extends Admin ? Omit<Admin, 'role'> : never;
type UserOrAdminWithoutAgeOrRole = UserWithoutAge | AdminWithoutRole;
let userWithoutAge: UserOrAdminWithoutAgeAndRole = {
id: 1,
name: 'Taro',
};
if (isUserWithoutAge(userWithoutAge)) {
console.log(userWithoutAge.id); // 1
console.log(userWithoutAge.name); // Taro
// userWithoutAge.age にはアクセスできません
}
let adminWithoutRole: UserOrAdminWithoutAgeAndRole = {
id: 2,
name: 'Jiro',
};
if (isAdminWithoutRole(adminWithoutRole)) {
console.log(adminWithoutRole.id); // 2
console.log(adminWithoutRole.name); // Jiro
// adminWithoutRole.role にはアクセスできません
}
この例では、isUserWithoutAge と isAdminWithoutRole 関数を使用して、age または role プロパティが存在しないオブジェクトを識別しています。これらの関数は、型ガードとして機能し、コンパイラにその後の型推論に必要な情報を提供します。
利点:
- 型ガードを使用することで、より柔軟な条件に基づいてプロパティを省略することができます。
- ランタイムチェックにより、コンパイルエラーだけでなく、実行時エラーも回避できます。
- 型ガードは、コードを冗長にする可能性があります。
- 複雑な条件を使用すると、コードが読みづらくなる可能性があります。
インターセクション型を使用して、ユニオン型の各構成要素から特定のプロパティを除外することができます。
type User = {
id: number;
name: string;
age: number;
};
interface Admin {
id: number;
name: string;
role: string;
}
type UserOrAdmin = User | Admin;
type UserWithoutAge = User & { age?: never };
type AdminWithoutRole = Admin & { role?: never };
type UserOrAdminWithoutAgeOrRole = UserWithoutAge | AdminWithoutRole;
let userWithoutAge: UserOrAdminWithoutAgeAndRole = {
id: 1,
name: 'Taro',
};
console.log(userWithoutAge.id); // 1
console.log(userWithoutAge.name); // Taro
// userWithoutAge.age にはアクセスできません
let adminWithoutRole: UserOrAdminWithoutAgeAndRole = {
id: 2,
name: 'Jiro',
};
console.log(adminWithoutRole.id); // 2
console.log(adminWithoutRole.name); // Jiro
// adminWithoutRole.role にはアクセスできません
この例では、UserWithoutAge 型と AdminWithoutRole 型を定義するために、インターセクション型を使用しています。これらの型は、User または Admin インターフェースのすべてのプロパティを持ちますが、age または role プロパティはオプションとなります。
- インターセクション型は、簡潔で読みやすいコードを記述できます。
- 型推論が良好に機能するため、コンパイラによるエラーチェックがより正確になります。
- インターセクション型は、複雑な構造を持つ型を扱う場合に難解
typescript
