新闻中心
TypeScript教程:使用映射类型和可选修饰符定义具有受限且可选键的对象

本教程旨在解决在 typescript 中定义对象类型时遇到的一个常见问题:如何确保对象的键来源于一个预定义的集合,但同时允许这些键是可选的,而非全部强制存在。文章将深入探讨如何结合使用映射类型(mapped types)和可选修饰符(?),以创建灵活且类型安全的对象结构,从而避免因缺少非必需属性而导致的编译错误。
在 TypeScript 开发中,我们经常
需要定义具有特定结构的对象,其中对象的键值(key)必须限定在某个预设的枚举或字符串集合中。然而,一个常见的挑战是,我们可能不希望对象必须包含该集合中的所有键,而是允许它们是可选的。本文将详细介绍如何利用 TypeScript 的映射类型(Mapped Types)和可选修饰符(Mapping Modifiers)来优雅地解决这一问题。
定义基础类型集合
首先,我们定义两个常量对象,它们将作为我们对象键的来源。使用 as const 可以确保 TypeScript 推断出最窄的字面量类型,而不是宽泛的 string 类型。
export const ABC = {
A: 'A',
B: 'B',
C: 'C',
} as const;
export const DEF = {
D: 'D',
E: 'E',
F: 'F',
} as const;接下来,我们基于这些常量对象创建联合类型(Union Types),这些联合类型将精确地表示允许的键值。
export type AbcTypes = (typeof ABC)[keyof typeof ABC]; // 类型为 'A' | 'B' | 'C' export type DefTypes = (typeof DEF)[keyof typeof DEF]; // 类型为 'D' | 'E' | 'F'
AbcTypes 和 DefTypes 现在分别是 ABC 和 DEF 对象中所有值组成的字面量联合类型。
初始尝试与遇到的问题
我们的目标是创建一个字典类型 MyNewDictionary,它的第一层键来自 AbcTypes,第二层键来自 DefTypes。每个最内层对象都包含 onClick 和 onCancel 两个函数。
一种直观的定义方式是使用映射类型:
type MyNewDictionaryAttempt = {
[pKey in AbcTypes]: {
[eKey in DefTypes]: {
onClick: () => void;
onCancel: () => void;
}
}
};然而,当我们尝试创建一个 MyNewDictionaryAttempt 类型的对象实例,并且只赋值了部分键时,TypeScript 编译器会报错:
Avatar AI
AI成像模型,可以从你的照片中生成逼真的4K头像
92
查看详情
const dictionaryAttempt: MyNewDictionaryAttempt = {
[ABC.A]: {
[DEF.D]: {
onClick: () => null,
onCancel: () => null,
}
}
};
/*
错误示例:
Type '{ D: { onClick: () => null; onCancel: () => null; }; }' is missing the following properties from type '{ D: { onClick: () => void; onCancel: () => void; }; E: { onClick: () => void; onCancel: () => void; }; F: { onClick: () => void; onCancel: () => void; }; }'
*/这个错误表明,尽管我们只为 ABC.A 下的 DEF.D 属性赋了值,但 MyNewDictionaryAttempt 类型要求 ABC.A 下必须包含 DEF.E 和 DEF.F,同样,整个 dictionaryAttempt 对象也必须包含 ABC.B 和 ABC.C。这是因为默认情况下,映射类型会创建所有属性都为必需(mandatory)的新类型。
解决方案:使用可选修饰符 ?
要解决这个问题,我们需要引入 TypeScript 的映射修饰符(Mapping Modifiers)。具体来说,使用 ? 修饰符可以将映射类型生成的属性标记为可选(optional)。
我们将 MyNewDictionaryAttempt 类型修改为 MyNewDictionary,在每个映射类型的键后面添加 ?:
type MyNewDictionary = {
[pKey in AbcTypes]?: { // 外层键现在是可选的
[eKey in DefTypes]?: { // 内层键现在也是可选的
onClick: () => void;
onCancel: () => void;
}
}
};通过在 [pKey in AbcTypes] 和 [eKey in DefTypes] 后面分别添加 ?,我们告诉 TypeScript:
- MyNewDictionary 对象可以包含 AbcTypes 中的任意键,但不需要全部包含。
- 对于 AbcTypes 中的每个键(例如 ABC.A),其对应的值(一个对象)可以包含 DefTypes 中的任意键,但同样不需要全部包含。
现在,我们可以按照预期创建对象实例,只包含我们需要的属性,而不会引发编译错误:
const dictionary: MyNewDictionary = {
[ABC.A]: {
[DEF.D]: {
onClick: () => console.log('A.D clicked'),
onCancel: () => console.log('A.D cancelled'),
},
// DEF.E 和 DEF.F 在这里是可选的,可以不写
},
[ABC.C]: { // ABC.B 也是可选的,可以不写
[DEF.F]: {
onClick: () => console.log('C.F clicked'),
onCancel: () => console.log('C.F cancelled'),
}
}
};
// 尝试访问存在的属性
if (dictionary[ABC.A]?.[DEF.D]) {
dictionary[ABC.A][DEF.D]?.onClick(); // 输出: A.D clicked
}
// 尝试访问不存在的属性(类型安全地处理 undefined)
console.log(dictionary[ABC.B]?.D?.onClick); // 输出: undefined总结与注意事项
- 映射类型 (Mapped Types): 允许你基于现有类型创建新类型,通过遍历一个联合类型或字面量类型的所有成员来生成新的属性。语法是 {[Key in UnionType]: ValueType}。
- 可选修饰符 (?): 在映射类型中使用 ? ({[Key in UnionType]?: ValueType}) 可以将生成的属性标记为可选。这意味着在创建该类型的对象时,这些属性可以被省略。
- as const 的重要性: 使用 as const 确保 TypeScript 推断出最具体的字面量类型,这对于创建精确的联合类型(如 AbcTypes)至关重要,从而使映射类型能够正确地工作。
- 嵌套可选性: 当处理嵌套对象时,如果希望内层属性也是可选的,需要在内层映射类型中也使用 ? 修饰符。
- 其他映射修饰符: 除了 ? (可选),还有 -? (必需),readonly (只读),和 -readonly (可写) 等修饰符,可以根据需求灵活组合使用。
通过掌握映射类型和可选修饰符,你可以在 TypeScript 中创建出更加灵活、健壮且类型安全的对象结构,有效管理复杂的配置或数据字典,同时避免不必要的强制性属性检查。
以上就是TypeScript教程:使用映射类型和可选修饰符定义具有受限且可选键的对象的详细内容,更多请关注其它相关文章!
# 在这里
# 网站优化网站靠谱
# 最优秀的无锡网站建设
# 宝贝关键词排名查询软件
# 四川网站推广哪家服务好
# 辽宁正规的网站建设公司
# 推广健康码视频素材网站
# 龙健网站建设
# 仓山区推广营销价格
# 北京外贸网络推广营销
# 网站推广和建设哪个好做
# 不需要
# 你可以
# typescript
# 这一
# 不写
# 键值
# 服务端
# 创建一个
# 修饰符
# 可选
# typescript教程
# 编译错误
# 常见问题
# win
# app
相关栏目:
【
科技资讯46185 】
【
网络学院92790 】
相关推荐:
《主播少女的秘密账号迷宫》首支宣传片
Pyrogram与g4f集成:异步编程实践与常见错误解决
必由学网页版入口 必由学官方平台直接访问
win11专注助手在哪 Win11免打扰模式设置与自动化规则【指南】
MongoDB Aggregation:在嵌套对象数组中精确匹配ObjectId
J*aScript map 迭代中检测空数组元素的有效方法
Win10如何恢复误删的快捷方式_Win10重建常用软件快捷方式
最新韩小圈网页版登录入口_官网在线观看官方链接
如何使用Node.js csv 包按条件移除含空字段的CSV记录
漫蛙漫画登录站点 漫蛙2正版漫画快速访问
React/Next.js中实现列表项的动态移动与状态管理:兼论唯一键的重要性
怎样使用“本地安全策略”提升Windows安全性_Secpol.msc配置指南【高手】
CSS自定义字体样式被系统字体替换怎么办_font-face方式指定font-display控制渲染策略
快速CSGO开箱网站指南 CSGO开箱平台推荐
AO3官方可用镜像 Archive of Our Own网页版最新入口
如何优雅地扩展SprykerGlue后端API授权逻辑,使用spryker/glue-backend-api-application-authorization-connector-extension
微信网页版官方入口教程 微信网页版网页版快速登录步骤
Win11如何开启讲述人功能 Win11屏幕阅读器(讲述人)开启与关闭【教程】
Go语言中对Map值调用带指针接收者方法:原理与最佳实践
《马克思佩恩3》早期版本曝光 UI设计曾多次调整!
京东单号查询入口_京东快递订单追踪入口
聚水潭ERP登录页面入口 聚水潭ERP官网登录界面
Node.js CSV 数据处理:基于字段值条件过滤整条记录的策略
Kafka Streams中基于消息头条件过滤消息的实现指南
斑马英语APP如何开启夜间护眼阅读_斑马英语APP夜间模式与低蓝光设置教程
WordPress插件开发:正确注册卸载钩子与避免常见陷阱
微信网页版登录教程_微信网页版登录入口在哪
新手怎么开始学化妆 零基础化妆入门教程
谷歌google账号注册详细步骤 谷歌账号注册官方教程
Composer如何处理Git子模块(submodule)依赖_Composer与Git Submodule的对比与选择
React Router v6 教程:构建认证保护的私有路由与重定向策略
HTML元素状态管理:根据DIV内容动态启用/禁用按钮
React列表渲染与独立状态管理:避免全局状态影响局部更新
期待已久:小米17 Ultra、小米首款NAS本月登场
品牌机怎么重装系统 联想/戴尔/惠普笔记本恢复出厂系统教程
C++20的source_location是什么_C++在编译期获取源码位置信息用于日志和断言
提升Kafka消费者健壮性:会话超时处理与消息处理语义
特斯拉自动驾驶房车计划曝光 原型车将于2027年亮相
XML中包含HTML标签导致解析错误? 正确嵌入非XML数据的两种方法
Django AJAX 文件上传教程:解决图片无法保存到模型的常见问题
126邮箱网页版官方入口 126邮箱账号在线登录平台
包子漫画官方网站在线链接-包子漫画在线阅读平台主页地址
windows10怎么查看本机ip_windows10命令提示符ipconfig使用
Golang如何使用new_Go new分配内存机制讲解
优化HTML表单样式:解决输入框焦点跳动与元素间距问题
C++编译期如何执行复杂计算_C++模板元编程(TMP)技巧与应用
Flexbox布局实践:实现粘性导航栏与底部固定页脚
《刺客信条:影》PS5 Pro和Switch 2画面对比
AO3最新可访问网址 Archive of Our Own官方在线入口
在Pyomo中实现基于变量的条件约束:Big-M方法详解


2025-11-22
浏览次数:次
返回列表