microsoft / microsoft/TypeScript

Distinct type specification for public field members

Đang mở
#54,829 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Awaiting More Feedback Suggestion
Ngôn ngữ chính
Go
Star
111k
Fork
14.4k
Merge trung bình
1 ngày 19 giờ
Pull request đã merge (30 ngày)
117

Mô tả

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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Issue không nêu tên tệp, test hay entry point nào. Hãy bắt đầu bằng việc xem xét parenthesized public modifier được đề xuất và cách nó tương tác với private, protected, readonly cùng các kiểu trường được suy luận; để được coi là hoàn tất, cần có một thiết kế đã được thống nhất và hành vi kiểm tra kiểu tương ứng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
typescript
Lĩnh vực
compilers
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
30/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.