0

0

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

看不見的法師

看不見的法師

发布时间:2025-11-12 22:30:55

|

272人浏览过

|

来源于php中文网

原创

交叉类型指同时具备多个类型的属性和方法,如 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 的所有属性,否则在启用类型检查时会报错。

Imagine By Magic Studio
Imagine By Magic Studio

AI图片生成器,用文字制作图片

下载

函数参数中标注交叉类型

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

/\*\*
 \* 处理既是用户又是管理员的对象
 \* @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),联合类型用 | 表示“或”的关系,而交叉类型用

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

47

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

194

2026.02.25

c语言union的用法
c语言union的用法

c语言union的用法是一种特殊的数据类型,它允许在相同的内存位置存储不同的数据类型,union的使用可以帮助我们节省内存空间,并且可以方便地在不同的数据类型之间进行转换。使用union时需要注意对应的成员是有效的,并且只能同时访问一个成员。本专题为大家提供union相关的文章、下载、课程内容,供大家免费下载体验。

129

2023.09.27

typedef和define区别
typedef和define区别

typedef和define区别在类型检查、作用范围、可读性、错误处理和内存占用等。本专题为大家提供typedef和define相关的文章、下载、课程内容,供大家免费下载体验。

119

2023.09.26

c语言typedef的用法
c语言typedef的用法

c语言typedef的用法有定义基本类型别名、定义结构体别名、定义指针类型别名、定义枚举类型别名、定义数组类型别名等。本专题为大家提供typedef相关的文章、下载、课程内容,供大家免费下载体验。

105

2023.09.26

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1926

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

656

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2395

2025.12.29

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

76

2026.03.11

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
React 教程
React 教程

共58课时 | 6万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 3.4万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号