0

0

JSDoc 类型定义中键名为 "event" 引发语法错误的解决方案

花韻仙語

花韻仙語

发布时间:2026-01-10 17:47:05

|

300人浏览过

|

来源于php中文网

原创

JSDoc 类型定义中键名为

jsdoc 类型注释中若对象字面量的键名为 event,eslint 的 jsdoc/valid-types 规则可能误将其识别为保留关键字或内部标识符,导致解析失败;推荐改用 @typedef + @type 组合写法或拆分为多个 @property 声明。

在 JavaScript 项目中使用 JSDoc 进行类型标注时,看似合法的类型语法有时会意外触发 ESLint 的 jsdoc/valid-types 报错。例如以下写法:

/**
 * @property {{event: Object.<string, MyEnum[]>, observation: Object.<string, MyEnum[]>}} enums
 */

尽管 event 是完全合法的普通对象键名(如 enums.event = {...}),但某些 JSDoc 解析器(尤其是 ESLint 的 eslint-plugin-jsdoc)在解析内联对象类型 {event: ...} 时,会将 event 误判为内置事件相关关键字(如 Event 构造函数、event 参数名等),从而中断类型解析流程,抛出 Syntax error in type 错误。

Kuwebs企业网站管理系统3.1.5 UTF8
Kuwebs企业网站管理系统3.1.5 UTF8

酷纬企业网站管理系统Kuwebs是酷纬信息开发的为企业网站提供解决方案而开发的营销型网站系统。在线留言模块、常见问题模块、友情链接模块。前台采用DIV+CSS,遵循SEO标准。 1.支持中文、英文两种版本,后台可以在不同的环境下编辑中英文。 3.程序和界面分离,提供通用的PHP标准语法字段供前台调用,可以为不同的页面设置不同的风格。 5.支持google地图生成、自定义标题、自定义关键词、自定义描

下载

推荐解决方案一:拆分 @property(最兼容、零风险)
避免在单个内联类型中声明含敏感键名的对象,转而为每个子属性单独标注:

/**
 * @property {Object} enums
 * @property {Object.<string, MyEnum[]>} enums.event
 * @property {Object.<string, MyEnum[]>} enums.observation
 */
const enums = {
  event: { 'click': [MyEnum.CLICK] },
  observation: { 'load': [MyEnum.LOAD] }
};

推荐解决方案二:使用 @typedef + @type(语义清晰、便于复用)
通过 @typedef 提前定义可复用类型别名,再用 @type 声明完整结构,彻底绕过内联解析歧义:

/**
 * @typedef {Object.<string, MyEnum[]>} MyEnumMap
 *
 * @type {{
 *   event: MyEnumMap,
 *   observation: MyEnumMap
 * }}
 */
const enums = {
  event: { 'submit': [MyEnum.SUBMIT] },
  observation: { 'error': [MyEnum.ERROR] }
};

⚠️ 注意事项:

  • Object. 是 Closure Compiler 风格语法,在较新版本的 eslint-plugin-jsdoc(v40+)中已支持,但若使用旧版插件,建议改用 TypeScript 风格泛型写法 Record(需启用 settings.jsdoc.mode: 'typescript');
  • 避免在类型字面量中使用其他潜在保留词作为键名,如 default、class、function、constructor 等,同样可能引发类似问题;
  • 若项目已接入 TypeScript,建议优先使用 .d.ts 文件或 JSDoc 的 @typedef 定义类型,而非过度依赖内联复杂类型。

综上,该问题本质是 JSDoc 工具链在类型解析阶段的关键词冲突,并非 JavaScript 语言限制。采用结构化声明(拆分 property)或抽象化建模(typedef + type)均可高效规避,同时提升代码可维护性与工具兼容性。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

43

2026.02.13

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

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

114

2026.02.25

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

910

2023.08.02

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

411

2023.10.18

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

357

2023.10.25

mysql标识符无效错误怎么解决
mysql标识符无效错误怎么解决

mysql标识符无效错误的解决办法:1、检查标识符是否被其他表或数据库使用;2、检查标识符是否包含特殊字符;3、使用引号包裹标识符;4、使用反引号包裹标识符;5、检查MySQL的配置文件等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

203

2023.12.04

Python标识符有哪些
Python标识符有哪些

Python标识符有变量标识符、函数标识符、类标识符、模块标识符、下划线开头的标识符、双下划线开头、双下划线结尾的标识符、整型标识符、浮点型标识符等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

313

2024.02.23

java标识符合集
java标识符合集

本专题整合了java标识符相关内容,想了解更多详细内容,请阅读下面的文章。

290

2025.06.11

Golang 测试体系与代码质量保障:工程级可靠性建设
Golang 测试体系与代码质量保障:工程级可靠性建设

Go语言测试体系与代码质量保障聚焦于构建工程级可靠性系统。本专题深入解析Go的测试工具链(如go test)、单元测试、集成测试及端到端测试实践,结合代码覆盖率分析、静态代码扫描(如go vet)和动态分析工具,建立全链路质量监控机制。通过自动化测试框架、持续集成(CI)流水线配置及代码审查规范,实现测试用例管理、缺陷追踪与质量门禁控制,确保代码健壮性与可维护性,为高可靠性工程系统提供质量保障。

48

2026.02.28

热门下载

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

精品课程

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

共58课时 | 5.6万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 3.2万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 3.5万人学习

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

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