TypeScriptプログラマー必見：GenericsとPartialライク型を活用した型システムの高度な利用方法

2024-05-24

TypeScriptのGenericsにおけるPartialライク型：必須プロパティを1つ設定する

なぜPartialライク型が必要なのか？

Partial<T>は、すべてのプロパティをオプションにする便利な型です。しかし、すべてのプロパティがオプションだと、オブジェクトが空になる可能性があります。これは、オブジェクトの検証や使用が困難になる場合があるため、望ましくない場合があります。

一方、少なくとも1つのプロパティを設定する必要がある型は、オブジェクトが空にならないことを保証します。これは、オブジェクトの検証や使用が容易になるため、場合によってはより好ましい場合があります。

Partialライク型を作成するには、以下の手順に従います。

AtLeastOne<T>型は、Partial<T>型と、少なくとも1つのプロパティが設定されていることを保証する型との交差型です。
```
type AtLeastOne<T> = Partial<T> & { [P in keyof T]?: never };
```
この型は、すべてのプロパティがnever型であるオブジェクトを許可しません。never型は、存在しない値を表します。つまり、すべてのプロパティがnever型のオブジェクトは、実際には空のオブジェクトです。
RequiredOne<T, K>型は、T型のKプロパティのみが必須で、他のプロパティはすべてオプションである型です。
```
type RequiredOne<T, K extends keyof T> = {
    [P in keyof T]: P extends K ? T[P] : Partial<T>[P];
};
```
この型は、KプロパティにT型の値を設定し、他のプロパティにはPartial<T>型の値を設定できます。

例

以下の例は、User型と、User型の少なくとも1つのプロパティを設定する必要があるRequiredOne<User, "name">型の使用方法を示しています。

interface User {
    name: string;
    email?: string;
    age?: number;
}

const user1: RequiredOne<User, "name"> = {
    name: "John Doe",
};

const user2: RequiredOne<User, "email"> = {
    email: "[email protected]",
};

// user1 and user2 are valid objects with at least one required property.

Partialライク型は、すべてのプロパティをオプションにする代わりに、少なくとも1つのプロパティを設定する必要がある型を作成する方法です。これは、オブジェクトの検証や使用が容易になるため、場合によってはより好ましい場合があります。

この方法を使用することで、より柔軟で型安全なコードを書くことができます。

interface User {
    name: string;
    email?: string;
    age?: number;
}

// Create a type that requires at least one property to be set.
type RequiredOne<T, K extends keyof T> = {
    [P in keyof T]: P extends K ? T[P] : Partial<T>[P];
};

// Create an object with at least one required property.
const user1: RequiredOne<User, "name"> = {
    name: "John Doe",
};

// Another object with a different required property.
const user2: RequiredOne<User, "email"> = {
    email: "[email protected]",
};

// user1 and user2 are valid objects with at least one required property.
console.log(user1); // { name: 'John Doe' }
console.log(user2); // { email: '[email protected]' }

このコードでは、まずUserインターフェースを定義します。このインターフェースには、name、email、ageという3つのプロパティがあります。

最後に、user1とuser2という2つのオブジェクトを作成します。user1オブジェクトはnameプロパティのみを設定し、user2オブジェクトはemailプロパティのみを設定します。

これらのオブジェクトはどちらも有効なオブジェクトであり、少なくとも1つの必須プロパティが設定されています。

このサンプルコードは、Partialライク型の使い方を理解するのに役立つはずです。

他の方法

Pick型とRequired型を組み合わせることで、少なくとも1つのプロパティを設定する必要がある型を作成できます。

type RequiredOne<T, K extends keyof T> = Required<Pick<T, K>> & Partial<Omit<T, K>>;

この型は、KプロパティのみをRequired型にし、他のプロパティはPartial型にします。

type RequiredOne<T, K extends keyof T> = {
    [P in keyof T]: P extends K ? T[P] : never;
};

function requiredOne<T, K extends keyof T>(obj: Partial<T>, requiredProperty: K): RequiredOne<T, K> {
    if (obj[requiredProperty] === undefined) {
        throw new Error(`Property '${requiredProperty}' is required.`);
    }

    return obj as RequiredOne<T, K>;
}

const user1 = requiredOne({ name: "John Doe" }, "name");
const user2 = requiredOne({ email: "[email protected]" }, "email");

// user1 and user2 are valid objects with at least one required property.

この関数は、objオブジェクトとrequiredPropertyプロパティを受け取ります。requiredPropertyプロパティがobjオブジェクトに設定されていない場合は、エラーをスローします。そうでなければ、objオブジェクトをRequiredOne<T, K>型に変換して返します。

Partialライク型を作成するには、いくつかの方法があります。どの方法を使用するかは、個々のニーズと好みによって異なります。