microsoft / microsoft/TypeScript

Distinct type specification for public field members

未关闭
#54,829 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

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

描述

Suggestion

Right now for a field of a class we can use the modifiers public, protected & private to control visibility outside of the class, and also readonly to control whether reassignment is permitted. For encapsulation purposes it is nice to have a field that is publicly accessible however not necessarily modifiable, for example with #-prefix'd fields we can do:

class Holder {
  #holds = new Set<number>();
  
  get holds(): ReadonlySet<number> {
    return this.#holds;
  }
}

Within the class one can use this.#holds to get a Set, or externally this.holds to get ReadonlySet. It would be nice if the above in-fact had a shorthand that didn't require an accessor specification, e.g.

class Holder {
  public(ReadonlySet<number>) holds = new Set<number>();
}

Which is functionally identical to the above (including in terms of inferred typing). The definition would be that:

The public modifier, if with parenthesis-form, is permitted in addition to the private/protected modifiers (both optional) and specifies an alternative type to infer in a public context. If specified without other modifiers the field is presumed private.

🔍 Search Terms

private, modifier, public, access, readonly, fields, members

List of keywords you searched for before creating this issue. Write them down here so that others can find this suggestion more easily and help provide feedback.

✅ Viability 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, new syntax sugar for JS, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

📃 Motivating Example

In order to detect bugs early narrow typing is often desirable to limit mutability of class fields, for example:

class ShardManager {
  held = new Set<number>();
  private lock = new DistributedLock();
 }
const shards = new ShardManger();

For brevity, ease of access, and succinct code, it is quite nice to be able to do shards.held in public code to get the list of currently held shards. However doing so also exposes risk, especially in libraries, as doing something simple like shards.held.add(5) could have unintended consequences by not respecting the assumptions the rest of the class makes (e.g. changes only occur under the lock).

To support this case we support a distinct type for public field access.

💻 Use Cases

Work-around:

class ShardManager {
  private myHeld = new Set<number>(); // Or #held
  private lock = new DistributedLock();
  get held(): ReadonlySet<number> {
    return this.myHeld;
  }
}

Is more lines of code, more verbose, and disconnects the access control from the field definition.

贡献指南

打开贡献指南

从这里开始

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

调研方向

该 issue 未指定任何文件、测试或入口点。首先检查提议的带括号的 public 修饰符,以及它与 private、protected、readonly 和推断字段类型之间的交互;要视为完成,需要确定设计并实现相应的类型检查行为。

由索引模型根据 Issue 内容生成。

评估

技术栈
typescript
领域
compilers
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
30/100

把新 issue 发到你的邮箱

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