microsoft / microsoft/TypeScript
Allow functions to have `new symbol` as the return type
未关闭
还没有人认领这个 Issue。
Awaiting More Feedback
Suggestion
- 主要语言
- Go
- 星标
- 111k
- 派生
- 14.3k
- 平均合并
- 2 天 4 小时
- 30 天内合并 PR
- 132
描述
Search Terms
- unique symbol
- new unique symbol
- new symbol
Suggestion
I request that unique symbol be allowed as the return type of a function declaration.
Alternatively, it might be better to use new symbol to disambiguate https://github.com/microsoft/TypeScript/issues/40106#issuecomment-677741032.
Use Cases
Currently, it’s impossible to create an alias or a wrapper function for the global Symbol constructor and use that to construct unique symbols:
// ./es-globals/fundamentals.js
export const ESSymbol = Symbol;
export const { for: ESSymbol_for } = ESSymbol;
// ./es-globals/fundamentals.d.ts
export import ESSymbol = globalThis.Symbol;
export declare const ESSymbol_for: typeof ESSymbol.for;
// ./symbols.js
import { ESSymbol, ESSymbol_for } from "./es-globals/fundamentals.js";
// should be `unique symbol`, but is instead `symbol`:
export const customSymbol = ESSymbol("custom");
// should be `unique symbol` or `global symbol "nodejs.util.inspect.custom"`,
// but is instead `symbol`:
export const nodejs_util_inspect_custom = ESSymbol_for("nodejs.util.inspect.custom");
// should be `unique symbol` or `global symbol "nodejs.util.promisify.custom"`,
// but is instead `symbol`:
export const nodejs_util_promisify_custom = ESSymbol_for("nodejs.util.promisify.custom");
Examples
This would allow defining SymbolConstructor as:
declare interface SymbolConstructor {
/**
* Returns a new unique Symbol value.
* @param description Description of the new symbol value.
*/
(description?: string | number): new symbol;
/**
* Returns a Symbol object from the global symbol registry matching the given key if found.
* Otherwise, returns a new symbol with this key.
* @param key key to search for.
*/
for<T extends string>(key: T): global symbol T;
// or, until GH-35909 is implemented:
for(key: string): new symbol;
}
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
See also
- https://github.com/microsoft/TypeScript/issues/36468
- https://github.com/microsoft/TypeScript/issues/35909 (
global symbol "<name>"proposal) - https://github.com/microsoft/TypeScript/pull/24738
- https://github.com/microsoft/TypeScript/issues/24506
- https://github.com/microsoft/TypeScript/issues/40106
- https://github.com/microsoft/TypeScript/pull/42543
- https://github.com/microsoft/TypeScript/issues/53282
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先查看提议的返回类型 unique symbol 和 new symbol、SymbolConstructor 示例,以及 See also 下列出的相关 issue 和 pull request。确定预期的类型语义和受影响的编译器行为;完成的工作应包括所请求的构造函数和注册表调用类型标注,同时不改变 JavaScript 输出。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- typescript
- 领域
- compilers
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100