Repository navigation
In JS, extra circular reference errors when referring to a missing property on module #26268
Closed as not planned
Description
I think this error is wrong, a result of #26236 combined with (probably) #25732. Here's a repro based on lodash:
var freeModule = module.nodeType;
var Buffer = module.nodeType ? root.Buffer : undefined;
/**
* Creates a clone of `buffer`.
*
* @private
* @param {Buffer} buffer The buffer to clone.
* @param {boolean} [isDeep] Specify a deep clone.
* @returns {Buffer} Returns the cloned buffer.
*/
function cloneBuffer(buffer, isDeep) {
}
module.exports = cloneBuffer;
Expected behavior:
No error on either type reference to Buffer in a param tag.
Actual behavior:
Error on both, and both say they have a circular reference error.
Activity
sandersn commentedon Aug 9, 2018
var freeModule = module.nodeTypemodule.nodeTypemoduleto a string.cloneBufferto a string.buffer.module.nodeType. Instead of going to (2) forever, issue an error that we have gone circular.This error is technically correct, but it is confusing because the real error is that
module.nodeTypeisn't found. This error is also logged, so this is just an extra error that should be removed if possible.[-]In JS, a possibly bogus circular reference error on param tag types[/-][+]In JS, extra circular reference errors when referring to a missing property on `module`[/+]sandersn commentedon Mar 13, 2019
Note that currently, only
@returns {Buffer}now gives an error.RyanCavanaugh commentedon Jul 23, 2025
Doesn't seem like a problem in practice