如何让JSDoc认可numberOfEggs类型变量的加法赋值操作?
解决JSDoc中
numberOfEggs类型相加后的赋值错误 你定义了带标签的numberOfEggs类型,当两个该类型变量相加时,TypeScript会将结果推断为基础number类型,导致无法直接赋值给numberOfEggs类型变量,触发Type 'number' is not assignable to type 'numberOfEggs'错误。以下是几种可行的解决方法:
方法一:显式类型断言
直接对相加结果进行类型断言,告诉TypeScript这个值符合numberOfEggs类型:
/** @typedef {number&{_tag: 'numberOfEggs'}} numberOfEggs */ /** @param {number} value */ const numberOfEggs = (value) => /** @type numberOfEggs */(value); /** @type {numberOfEggs} */ let nA = numberOfEggs(1); /** @type {numberOfEggs} */ let nB = numberOfEggs(1); // 显式断言类型 /** @type {numberOfEggs} */ let nC = /** @type numberOfEggs */(nA + nB);
方法二:封装加法工具函数
创建一个专门处理numberOfEggs类型相加的函数,通过JSDoc标注参数和返回值类型,既能避免重复断言,也能保证类型安全:
/** @typedef {number&{_tag: 'numberOfEggs'}} numberOfEggs */ /** @param {number} value */ const numberOfEggs = (value) => /** @type numberOfEggs */(value); /** * 计算两个numberOfEggs类型的和 * @param {numberOfEggs} a * @param {numberOfEggs} b * @returns {numberOfEggs} */ const addEggs = (a, b) => /** @type numberOfEggs */(a + b); /** @type {numberOfEggs} */ let nA = numberOfEggs(1); /** @type {numberOfEggs} */ let nB = numberOfEggs(1); // 使用工具函数赋值 let nC = addEggs(nA, nB);
方法三:利用TypeScript类型扩充(进阶)
如果项目允许使用TypeScript高级特性,可以通过模块扩充为numberOfEggs类型添加加法运算的类型支持,适合复杂场景:
/** @typedef {number&{_tag: 'numberOfEggs'}} numberOfEggs */ // 扩充类型,定义加法运算的返回类型 declare global { interface Number { /** @returns {numberOfEggs} */ __add__(other: numberOfEggs): numberOfEggs; } } // 实现加法方法(可选,仅用于运行时) Number.prototype.__add__ = function(other) { return /** @type numberOfEggs */(this + other); }; /** @param {number} value */ const numberOfEggs = (value) => /** @type numberOfEggs */(value); /** @type {numberOfEggs} */ let nA = numberOfEggs(1); /** @type {numberOfEggs} */ let nB = numberOfEggs(1); // 使用自定义加法方法 let nC = nA.__add__(nB);
内容的提问来源于stack exchange,提问作者Leo
相关产品推荐
相关产品推荐

