
在 typescript 中使用条件属性:一个实际示例
在 typescript 中,条件属性允许我们创建灵活且类型安全的接口,可以根据某些条件进行调整。这在处理复杂的数据结构时特别有用,其中某些属性只应在特定情况下出现。在这篇博文中,我们将通过涉及奖励组的实际示例来探索如何使用条件属性。
场景
想象一下我们有一个管理不同类型奖励的系统。每个奖励可以是特定类型,例如“金融”或“运输”。
根据奖励类型,应包含或排除某些属性。例如,财务奖励应包括财务属性,而运输奖励应包括运输属性。此外,我们希望确保仅根据奖励类型和奖励条件包含某些属性。
定义类型
首先,让我们定义我们将使用的基本类型和接口:
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[];
}
使用条件类型
柏顿企业网站管理系统(免费版)秉承了东莞柏顿软件的一惯原则(致力于打造简洁、实用、绿色的管理系统)而推出的一款适合广大中小型企业的网站管理系统。主要功能如下:1.基本设置:联系方式、关键字、版权信息等等;2.菜单管理:用户可以在线增加、删除、修改和隐藏前台的菜单栏目和菜单项3.新闻系统:支持二级分类,可分类查看新闻、修改新闻、批量推荐、删除新闻,可设置是否推荐、新闻点击等4.产品系统: 产品类别新
为了确保仅当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。
对于任何其他不是“finance”的rewardtype 和rewardon,将包含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
};









