node.js - 如何记录使用 object.defineProperty 定义的 module.exports

Question

我正在使用 NodeJS 并尝试让 JSDoc 来获取我正在做的事情。我有一些代码，如下所示:

Object.defineProperty(module, 'exports', {
    enumerable: true,
    configurable: true,
    get: function() {
        const factory = {};

        /**
         * Output message to the console
         * @param {string} str
         */
        factory.foo = function(str) {
            console.log(str);
        };

        return factory;
    }
});

在这种情况下，不能选择以标准方式导出 foo exports.foo = function(str) { ... }。

另一个模块可以包含此模块可以访问 foo (就像直接导出一样)。例如:

var x = require('./x');
x.foo('Hello');

那么我如何记录这个，以便 jsDoc 发现这个模块有一个函数 foo？

Answer 1

我找到了一种似乎有效的方法:

Object.defineProperty(module, 'exports', {
    enumerable: true,
    configurable: true,
    get: Factory
});

/**
 * Get a factory object.
 * @returns {Factory}
 * @constructor
 */
function Factory() {
    var factory = Object.create(Factory.prototype);

    /**
     * Output a message to the console.
     * @name Factory#foo
     * @param {string} str
     */
    factory.foo = function(str) {
        console.log(str);
    };

    return factory;
}