讲师中心 微信公众号
AI工具推荐 视频效率加速

如何为动态生成类的 JavaScript 函数编写准确的 JSDoc 返回类型

浅丽同学_9568

浅丽同学_9568

发布时间:2026-08-05 23:08:25

|

795人浏览过

|

来源于php中文网

原创

如何为动态生成类的 JavaScript 函数编写准确的 JSDoc 返回类型

JSDoc 目前不支持精确描述“继承自传入类并扩展新方法”的动态类构造函数的返回类型;虽有变通方案(如 @constructor + @extends 组合),但无法完全模拟 TypeScript 的泛型类继承推导,工具链兼容性有限。

jsdoc 目前不支持精确描述“继承自传入类并扩展新方法”的动态类构造函数的返回类型;虽有变通方案(如 `@constructor` + `@extends` 组合),但无法完全模拟 typescript 的泛型类继承推导,工具链兼容性有限。

在纯 JavaScript 项目中,使用 JSDoc 为返回动态类的高阶函数(如 createClientClass)标注类型时,开发者常面临一个核心限制:JSDoc 缺乏对“类构造器类型”(constructor type)的一等公民支持。这意味着你无法像 TypeScript 那样用 new T() 或 typeof MyClass 精确表达“返回一个可实例化的、继承自 UserProvidedClass 并混入额外成员的类”。

✅ 可行的 JSDoc 实践方案(有限但实用)

虽然无法实现 100% 类型完整性,以下写法可在主流编辑器(如 VS Code)中提供最佳可用的智能提示:

/**
 * 创建一个继承自 `UserProvidedClass` 的新类,并为其添加客户端连接能力。
 * @template {new (...args: any[]) => any} T
 * @param {T} UserProvidedClass - 用户提供的基类(必须是可构造的类)
 * @returns {new (...args: ConstructorParameters<T>) => InstanceType<T> & {
 *   bindServerSocket(socket: WebSocket): void;
 *   onConnect(): void;
 *   server?: WebSocket;
 * }} 构造器函数,返回的实例同时拥有基类方法和新增方法
 */
function createClientClass(UserProvidedClass) {
  return class ClientClass extends UserProvidedClass {
    bindServerSocket(socket) {
      this.server = socket;
      this.onConnect();
    }
    onConnect() {
      super.onConnect?.();
      if (DEBUG) console.log('client connected');
    }
  };
}

? 关键点解析:

javascript-pro
javascript-pro

专注现代 ECMAScript、异步编程、性能优化和全栈的 JavaScript 专家,适用于现代开发

下载
  • @template {new (...args: any[]) => any} T:声明 T 是一个构造函数类型(非实例);
  • @returns {new (...) => ...}:显式定义返回值为构造函数类型,而非实例;
  • InstanceType<T> & { ... }:将基类实例类型与新增属性/方法交叉合并,模拟“继承+扩展”效果。

⚠️ 注意事项与局限性

  • 工具链差异大:VS Code(基于 TypeScript 语言服务)能较好解析上述语法,但 WebStorm 或某些 LSP 实现可能忽略 new (...) => 类型或无法正确联合 InstanceType<T>;
  • 无运行时校验:JSDoc 仅为开发时提示,不提供类型安全保证,需配合 ESLint(如 @typescript-eslint/no-unsafe-call)加强约束;
  • 无法推导 super 成员调用链:instance.test()(来自 CustomClass)在部分配置下仍可能提示“未定义”,因工具难以逆向追踪 InstanceType<T> 的完整原型链;
  • 避免滥用 @typedef 模拟类:手动定义 @typedef {class extends CustomClass {...}} ClientClass 属于“伪类型”,破坏泛化性且维护成本高。

✅ 推荐工作流(务实优先)

  1. 采用上述 @template + new (...) => 写法,作为当前最接近理想的 JSDoc 方案;
  2. 在项目根目录添加 jsconfig.json,启用更强的类型推导:
    {
      "compilerOptions": {
        "checkJs": true,
        "allowSyntheticDefaultImports": true,
        "maxNodeModuleJsDepth": 2
      },
      "include": ["**/*.js"],
      "exclude": ["node_modules"]
    }
  3. 对关键调用点补充局部类型断言(必要时):
    /** @type {InstanceType<typeof ClientClass>} */
    const instance = new ClientClass();

? 总结

JSDoc 尚未原生支持“带泛型的类构造器返回类型”这一高级场景——这并非使用错误,而是规范本身的长期缺口(参见 JSDoc Issue #1349)。在迁移到 TypeScript 前,推荐以 @template + new (...) => 为核心方案,在可接受的精度损失范围内最大化开发体验。若类型严谨性为刚性需求,应视此为推动项目类型化升级的重要技术动因。

立即学习“Java免费学习笔记(深入)”;

热门AI工具

更多
LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

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

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

4406

2023.06.20

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

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

1109

2023.07.04

js四舍五入
js四舍五入

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

4324

2023.07.04

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

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

880

2023.09.01

JavaScript转义字符
JavaScript转义字符

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

1776

2023.09.04

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

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

3185

2023.09.04

如何启用JavaScript
如何启用JavaScript

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

4133

2023.09.12

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

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

2660

2023.09.20

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

20

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

React 教程
React 教程

共58课时 | 12万人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn