0

0

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

碧海醫心

碧海醫心

发布时间:2026-01-10 20:47:02

|

995人浏览过

|

来源于php中文网

原创

JSDoc 类型定义中键名

eslint 的 `jsdoc/valid-types` 规则会将对象字面量类型中名为 `event` 的键误识别为保留关键字或内部标识符,导致解析失败;可通过拆分 `@property` 声明、使用 `@typedef` 抽离类型,或改用 `@type` + 字面量注解等方式规避该限制。

在 JavaScript 项目中使用 JSDoc 进行类型标注时,你可能会遇到一个看似奇怪的限制:当对象类型定义中包含键名为 "event" 时(例如 {event: Object.}),ESLint 的 jsdoc/valid-types 规则会抛出 Syntax error in type 错误,而将键名改为 "events" 或 "evt" 却能正常通过。这并非 JavaScript 语法问题,而是 ESLint 的 JSDoc 插件(如 eslint-plugin-jsdoc)在解析类型字符串时存在关键字冲突或解析歧义——它可能将 "event" 误判为内置事件相关标识符(如 Event 构造函数、event 参数名等),从而提前终止类型解析。

✅ 推荐解决方案(按优先级排序)

1. 拆分为独立 @property 声明(最简洁、兼容性最佳)

避免在单个内联对象类型中声明 event 键,转而为每个属性单独注解:

/**
 * @property {Object} enums
 * @property {Object.} enums.event
 * @property {Object.} enums.observation
 */
const enums = {
  event: { /* ... */ },
  observation: { /* ... */ }
};

✅ 优势:无需修改变量结构,完全绕过内联对象解析器缺陷;所有主流工具(VS Code、TypeScript、ESLint)均能正确推导类型。

2. 使用 @typedef + @type 组合(语义清晰、可复用)

将复杂类型抽离为命名类型,再通过 @type 显式标注变量:

LALALAND
LALALAND

AI驱动的时尚服装设计平台

下载
/**
 * @typedef {Object.} MyEnumMap
 *
 * @type {{
 *   event: MyEnumMap,
 *   observation: MyEnumMap
 * }}
 */
const enums = {
  event: {},
  observation: {}
};

⚠️ 注意:确保 MyEnum 已正确定义(如通过 @enum 或外部类型声明),否则 MyEnumMap 可能被误报为未定义类型。

3. 替代语法:改用 Record(TypeScript 用户推荐)

若项目已启用 TypeScript 支持,可使用更现代的泛型语法提升可读性与健壮性:

/**
 * @type {Record<'event' | 'observation', Record}
 */
const enums = { /* ... */ };
? 提示:Record 是 TypeScript 内置工具类型,在支持 JSDoc 的 TS 环境中解析稳定,且不会触发 event 关键字误判。

⚠️ 注意事项

  • 不要依赖 @property {{event: ...}} 这类内联对象字面量写法中的敏感键名(如 event, class, function, return),它们在部分 JSDoc 解析器中属于高风险词。
  • ESLint 插件版本影响显著:升级至 eslint-plugin-jsdoc@40+ 可缓解部分解析问题,但仍建议采用上述防御性写法。
  • 若使用 VS Code,拆分式 @property 注解能提供更精准的悬停提示和自动补全支持。

通过结构化声明替代紧凑内联类型,不仅规避了工具链的解析陷阱,也让 JSDoc 更易维护、协作更清晰——类型即文档,清晰胜于简短。

相关专题

更多
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号