JS注解怎么标注交叉类型_ JS交叉类型参数的注解方法与示例

交叉类型指同时具备多个类型的属性和方法,如 User & Admin 要求值包含两个类型的全部成员,可通过 jsDoc 的 @typedef 和 {T & U} 语法模拟实现,用于变量或参数注解以确保结构完整。

JS注解怎么标注交叉类型_ JS交叉类型参数的注解方法与示例

javaScript中,严格来说并没有“交叉类型”这一概念,这是typescript中的类型系统特性。但如果你使用的是支持类型注解的JS环境(如通过JSDoc配合现代编辑器或TypeScript的checkJS模式),你可以用JSDoc模拟类似TypeScript中交叉类型的写法。

什么是交叉类型(Intersection Type)?

交叉类型表示一个类型同时具备多个类型的属性和方法。例如,A & B 类型的值必须同时满足A类型和B类型的结构。

@typedef结合JSDoc实现交叉类型注解

在JSDoc中,可以通过 @typedef 定义复合类型,并使用 & 语法(需TypeScript解析支持)或 {&} 结构来表达交叉。

实际中,常用 (* @type {T & U} *) 的形式标注一个值同时属于两个类型。

 /**  * @typedef User  * @property {string} name  * @property {number} age  */ <p>/** * @typedef Admin * @property {string} role * @property {boolean} isAdmin */</p><p>// 定义一个变量是 User 和 Admin 的交叉类型 /** @type {User & Admin} */ const userAdmin = { name: "Alice", age: 30, role: "manager", isAdmin: true };</p>

上面的例子中,userAdmin 必须包含 User 和 Admin 的所有属性,否则在启用类型检查时会报错。

JS注解怎么标注交叉类型_ JS交叉类型参数的注解方法与示例

神卷标书

神卷标书,专注于AI智能标书制作、管理与咨询服务,提供高效、专业的招投标解决方案。支持一站式标书生成、模板下载,助力企业轻松投标,提升中标率。

JS注解怎么标注交叉类型_ JS交叉类型参数的注解方法与示例 39

查看详情 JS注解怎么标注交叉类型_ JS交叉类型参数的注解方法与示例

函数参数中标注交叉类型

你也可以在函数参数中使用交叉类型注解,确保传入的对象满足多个类型约束。

 /**  * 处理既是用户又是管理员的对象  * @param {User & Admin} person - 用户兼管理员  */ function handleUserAdmin(person) {   console.log(`${person.name} 是 ${person.role}`);   if (person.isAdmin) {     // 执行管理员逻辑   } } <p>// 调用时必须传入符合 User 和 Admin 结构的对象 handleUserAdmin(userAdmin); // ✅ 正确 handleUserAdmin({ name: "Bob", age: 25 }); // ❌ 缺少 Admin 属性,类型检查会提示错误</p>

接口合并的等效性说明

TypeScript中交叉类型常用于合并接口。在JSDoc中虽然不能定义Interface,但 @typedef 可以达到类似效果。

注意:交叉类型不是联合类型(union),联合类型用 | 表示“或”的关系,而交叉类型用

上一篇
下一篇
text=ZqhQzanResources