TS Confuses namespace with the class on JSDoc module.exported class with static method.

未关闭
#55,875 1 条评论 4 个 reaction 已指派 1 人 在 GitHub 查看

@sandersn 已经在做这个了。

开始于 2023年10月4日。

评估

这个 Issue 还没有评估数据。

描述

Bug Domain: JSDoc Help Wanted
🔎 Search Terms

"module.exports static method" "namespace vs class confusion" "namespace vs class collision" "Two different types with this name exist, but they are unrelated."

🕗 Version & Regression Information

Versions tried:

  • Version 5.3.0-dev (55d8bed85c11672b2b6f9ee3e6e1d384bef6f4da - )
  • Version 5.2.2
  • Version 5.1.6
  • Version 5.0.4
  • Version 4.9.5
⏯ Playground Link

https://www.typescriptlang.org/dev/bug-workbench/?noUnusedLocals=true&noUnusedParameters=true&checkJs=true&allowJs=true&module=1&emitDeclarationOnly=true&stripInternal=true#code/PTAEAEFsHsBMFcA2BTAXKAxtSMB2ArAZwCgQIYEUAlZQ6ReAFwEtpd0A5OZUscWZBkQBDAE7CWbXhGSRmjACKCR4ybgDyuRAE9p4YYkTQA7gCkSZcBgAWggNbm9jMQHNkjUACIAogGUATAAMQZ56iMwARqAA2j4BwYGeALp6hIyizAAOAJK4jMiiuAZ6uNDZkJnhGPIAKtbMFnylAKq48ITIsAAy0BgGjRAtbR2wAApiwpDuBSR6AGbMKEVT6MvIAHRExADk7cigaRkYjNsA3MSkAFSXxKCXoOqZaoSgc9CioIy2oLjuwrCwUS0QjrW73cCMbSZTrIOagADe6gi+EEjAAvqAOJNkI9nmCIJlRNBoaJIQjfOlmLgXBi1mDgBdgNd8Rx3KAAIIAoGEEh3UA0Qm0ZB5F7CH7uYzvOygf6A4Ggu4M4hCYQ8zHYhG3UBM8GQ6HkynUjGXBmgH7Y85anVavkAYSBEn2Yt+jElomlsu5IJtJouZqwuEO8GO7wAFABKTVms1fBrrNagAC8oG2+TSZy1aL92uZ0fuuRRx1AhOJBRYtFeRMgoGs0DSABpi+9GI3hLhYOLXVKFWbwZkJtX4RSMkbzVMfRAgYx4IUXvDY4Qs3mlWa5lWsVNQ2tI-CbZ96iCE8m1udo6ApzPcPuGqfQFmrbnewSBwaRzSxzw85P3Je5xvkEuvYrgczgsBglbYP+W7Yjue4XoU4rGNehARusa6Qdi0FTOGt5ZveTL4t4AAemR1p+vrEBQSAbMgJHNi8yb-palgLEs2LoO0whuJsJC7B0IFHCcloBmk6pTEm57IAAjvAzBAqG2zrMAazbDhjLXBAer7PC-7GgyKAeJ6wKWkZarHsgSFQWpxCmYeGrJtsdBTCpzF8KxwrscWwgYHYXEbEQUjwp4hLMAAbo6njoOk8AAUAA

💻 Code
// @filename: name.js
'use strict';

/**
 * Options for the netaddress.
 * @typedef {Object} NameOptions
 * @property {String} name
 */

/**
 * Net Address
 * Represents a network address.
 */

class Name {
  /** @type {String} */
  name;

  /**
   * Create a network address.
   */

  constructor() {
    this.name = 'test';
  }

  /**
   * Inject properties from host, port, and network.
   * @param {String} name
   * @returns {this}
   */

  fromName(name) {
    this.name = name;
    return this;
  }

  /**
   * @param {String} name
   * @returns {Name}
   */

  static fromName(name) {
    return new this().fromName(name);
  }
}

/*
 * Expose
 */

module.exports = Name;
// @filename: usage.js
'use strict';

const Name = require('./name');

/** @type {Name} */
let address;

address = new Name();

address.name = 'somename';
🙁 Actual behavior

This reports an error:

Type 'import("/name")' is not assignable to type 'import("/name")'. Two different types with this name exist, but they are unrelated.
  The types returned by 'fromName(...)' are incompatible between these types.
    Type 'Name' is not assignable to type 'this'.
      'Name' is assignable to the constraint of type 'this', but 'this' could be instantiated with a different subtype of constraint 'Name'.
🙂 Expected behavior

new Name() and @type {Name} should be the same as module.exports = Name class.

Additional information about the issue

Repository format: https://github.com/nodech/type-tsjs-tests

generated declaration file for name.js is in the form:

export = Name;

declare class Name {...}
declare namespace Name { export { NameOptions } }
type NameOptions

If you remove @typedef {Object} NameOptions from the name.js, the declaration becomes

export = Name;

declare class Name {...`

and issue goes away.

More confusing

If you leave NameOptions but remove static member static fromName of the class Name, it still has namespace and class with the same name, BUT issue goes away ?

主要语言
Go
星标
111k
派生
14.4k
平均合并
1 天 19 小时
30 天内合并 PR
117

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

microsoft/TypeScript 的其他 Issue

查看 microsoft/TypeScript 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。