TypeScript에서 조건부 속성 사용: 실제 예

TypeScript에서 조건부 속성을 사용하면 특정 조건에 따라 적응하는 유연하고 유형이 안전한 인터페이스를 만들 수 있습니다. 이는 특정 속성이 특정 상황에서만 존재해야 하는 복잡한 데이터 구조를 처리할 때 특히 유용합니다. 이번 블로그 게시물에서는 보상 그룹과 관련된 실제 예를 통해 조건부 속성을 사용하는 방법을 살펴보겠습니다.

시나리오

다양한 유형의 보상을 관리하는 시스템이 있다고 상상해 보세요. 각 보상은 "FINANCE" 또는 "SHIPPING"과 같은 특정 유형일 수 있습니다.

리워드 유형에 따라 특정 속성이 포함되거나 제외되어야 합니다. 예를 들어 금전적 보상에는 금전적 속성이 포함되어야 하고 배송 보상에는 배송 속성이 포함되어야 합니다. 또한, 보상 유형 및 조건에 따른 보상에 따라 특정 속성만 포함되기를 원합니다.

유형 정의

먼저 작업할 기본 유형과 인터페이스를 정의해 보겠습니다.

type RewardType = "FINANCE" | "SHIPPING" | "OTHER"; // Example values for RewardType

interface ItemConditionAttribute {
  // Define the properties of ItemConditionAttribute here
}

interface RewardAttributes {
  // Define the properties of RewardAttributes here
}

interface ShippingAttributes {
  // Define the properties of ShippingAttributes here
}

interface FinanceAttributes {
  // Define the properties of FinanceAttributes here
}

interface RewardGroupBase {
  groupId: number;
  rewardType: RewardType;
  rewardOn: string;
  itemConditionAttributes: ItemConditionAttribute[];
}

조건부 유형 사용

rewardType이 'FINANCE'인 경우에만 financeAttributes가 포함되고 rewardOn이 'Finance'인 경우 rewardAttributes가 포함되지 않도록 하려면 조건부 유형을 사용할 수 있습니다. RewardGroup 유형을 정의하는 방법은 다음과 같습니다.

type RewardGroup = RewardGroupBase & (
  { rewardType: "FINANCE"; rewardOn: "Finance"; financeAttributes: FinanceAttributes; rewardAttributes?: never; shippingAttributes?: never } |
  { rewardType: "SHIPPING"; rewardOn: Exclude; shippingAttributes: ShippingAttributes; financeAttributes?: never; rewardAttributes: RewardAttributes } |
  { rewardType: Exclude; rewardOn: Exclude; financeAttributes?: never; shippingAttributes?: never; rewardAttributes: RewardAttributes }
);

설명

기본 인터페이스:
RewardGroupBase에는 보상 유형에 관계없이 항상 존재하는 공통 속성이 포함되어 있습니다.

조건부 유형:
조건부 속성을 처리하기 위해 세 가지 유형의 공용체를 사용합니다.

• rewardType이 'FINANCE'이고 rewardOn이 'Finance'인 경우 financeAttributes가 필수입니다.
  그리고 rewardAttributes 및 ShippingAttributes는 허용되지 않습니다.

• rewardType이 'SHIPPING'이고 rewardOn이 'Finance'가 아닌 경우 ShippingAttributes는 필수이며 financeAttributes는 허용되지 않지만 rewardAttributes는 포함됩니다.

• rewardType 및 rewardOn이 'Finance'가 아닌 경우 rewardAttributes는 포함되지만 financeAttributes나 ShippingAttributes는 모두 포함되지 않습니다.

사용 예

실제로 RewardGroup 유형을 사용하는 방법은 다음과 같습니다.

const financeReward: RewardGroup = {
  groupId: 1,
  rewardType: "FINANCE",
  rewardOn: "Finance",
  itemConditionAttributes: [ /* properties */ ],
  financeAttributes: { /* properties */ }
};

const shippingReward: RewardGroup = {
  groupId: 2,
  rewardType: "SHIPPING",
  rewardOn: "Delivery",
  itemConditionAttributes: [ /* properties */ ],
  shippingAttributes: { /* properties */ },
  rewardAttributes: { /* properties */ }
};

// This will cause a TypeScript error because financeAttributes is not allowed for rewardType "SHIPPING"
const invalidReward: RewardGroup = {
  groupId: 3,
  rewardType: "SHIPPING",
  rewardOn: "Delivery",
  itemConditionAttributes: [ /* properties */ ],
  financeAttributes: { /* properties */ } // Error: financeAttributes
};