TS Confuses namespace with the class on JSDoc module.exported class with static method.
@sandersn 已经在做这个了。
开始于 2023年10月4日。
评估
这个 Issue 还没有评估数据。
描述
🔎 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
💻 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
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
microsoft/TypeScript 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 88/100
microsoft/TypeScript#64322 · 2 条评论 · 1 个 reaction · 已指派 2 人 ·
-
Possible Improvement
难度 2/5 1-3 小时 新手友好度 78/100
microsoft/TypeScript#64278 · 1 条评论 · 1 个 reaction ·
-
Docs
难度 2/5 1-3 小时 新手友好度 70/100
microsoft/TypeScript#64118 · 1 条评论 ·
-
难度 1/5 1 小时以内 新手友好度 88/100
microsoft/TypeScript#64094 ·
-
Docs
难度 2/5 1-3 小时 新手友好度 76/100
microsoft/TypeScript#63959 · 5 条评论 ·
查看 microsoft/TypeScript 的全部 Issue
相似的 Issue
-
kind/bug
难度 2/5 1-3 小时 新手友好度 88/100
kubernetes-sigs/prow#953 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 88/100
caddyserver/caddy#8046 ·
-
难度 2/5 1-3 小时 新手友好度 86/100
-
L1 recommended for recruits
难度 2/5 1-3 小时 新手友好度 88/100
-
area/entangle bug
难度 1/5 1 小时以内 新手友好度 92/100