如何导出模块接口的typedef？

Question

假设我有这个模块foo与方法bar和baz ：

function foo(){
  function bar() {}
  function baz() {}

  return { bar, baz }
}

我想定义返回的 object 的类型，以便可以将其导入到不同的文件中。 但是@typedef只有在文件的外部 scope 中才能导入。

这是一种“有效”的方法，可以实现预期的结果，但可能对某些类型的模块实现没有弹性。

function foo(){
  function bar() {}
  function baz() {}

  return { bar, baz }
}

let type = foo() // Create a arbitrary instance
/** @typedef {type} foo */

是否有一种有意的方式来定义模块接口对象的类型？

另外，我发现在外部范围内为整个 object 手动编写 typedef 并不是一个好的解决方案，因为文档已经在每种方法中编写过一次。

Answer 1

我使用 IDEA 进行开发，我将所有数据类型放在一个单独的文件中，并且我已经向函数指定了数据类型。

也许我不太明白你的问题，但我会指出我所看到的实现。 有必要描述一次数据类型，指定一次返回什么，一切都应该工作。

外部文件中类型的描述

/**
* @typedef {Object} barRet
* @property {string} name
* @property {boolean} isOpen
*/

/**
* @typedef {Object} bazRet
* @property {number} openClock
* @property {number} closeClock
*/

/**
* @typedef {Object} fooReturned
* @property {barRet} bars
* @property {bazRet} bazs
*/

在 function 的代码中，我们指定了返回的数据类型

/**
* @returns {fooReturned}
*/
function foo(){
    /** @return {barRet} */
    function bar() {}
    /** @return {bazRet} */
    function baz() {}

    return { bars: bar, bazs: baz }
}

const fooResult = foo(); // I see fooResult type of fooReturned