如何使用JSDoc为递归闭包编写显式返回类型注释

Question

在一个使用vanilla JS的项目中，我有一个相当复杂的用例，它使用tsc检查类型，并用JSDoc注释编写类型注释。我有一个返回函数的函数，返回的函数可以递归调用自己，同时也重新分配一些闭包变量。

这是一个愚蠢的例子，它明白了这一点并会抛出同样的错误：

/**
 * @returns {function(): number}
 */
function circular() {
  let num = Math.random();

  return function tryAgain() {
    if (num < 0.5) {
      return num;
    }

    num = Math.random();
    return tryAgain();
  };
}

因此，如果我使用tsc对此代码运行类型检查：

tsc --allowJs --checkJs --noEmit --strict --target ES2017 *.js

我得到以下错误：

error TS7023: 'tryAgain' implicitly has return type 'any' because it does not have a return type annotation and is referenced directly or indirectly in one of its return expressions.

首先，这个错误似乎相当错误。我显然有一个显式的返回类型注释，这是使用适当的TypeScript而不是JSDoc为类似循环引用提出的解决方案。

但是我很乐意使用任何变通方法来编译它，而无需大量重构来删除闭包和/或递归。我已经尝试了许多可能的变通方法，但都没有奏效。

用注释包装返回函数：

  return /** @type {function(): number} */ (function tryAgain() {
    . . .
  });

用注释包装递归调用：

    return /** @type {number} */ (tryAgain());

使用强制包装递归调用：

    return Number(tryAgain());

在这一点上，我完全困惑于如何正确地注释它，或者至少如何让该死的东西编译。

Answer 1

将函数定义与返回分开，可以对tryAgain进行注释，从而消除错误：

/**
 * @returns {function(): number}
 */
function circular() {
  let num = Math.random();

  /**
   * @returns {number}
   */
  function tryAgain() {
    if (num < 0.5) {
      return num;
    }

    num = Math.random();
    return tryAgain();
  }

  return tryAgain;
}

内联操作同样有效：

/**
 * @returns {function(): number}
 */
function circular() {
  let num = Math.random();

  return /** @returns {number} */ function tryAgain() {
    if (num < 0.5) {
      return num;
    }

    num = Math.random();
    return tryAgain();
  };
};