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., observation: Object.}} 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.} enums.event
 * @property {Object.} enums.observation
 */
const enums = {
  event: { 'click': [MyEnum.CLICK] },
  observation: { 'load': [MyEnum.LOAD] }
};

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

/**
 * @typedef {Object.} 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)均可高效规避,同时提升代码可维护性与工具兼容性。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

552

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

374

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

730

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

475

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

394

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

990

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

656

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

551

2023.09.20

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

25

2026.01.09

热门下载

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

精品课程

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

共58课时 | 3.5万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 2.1万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.8万人学习

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

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