microsoft / microsoft/TypeScript
Add a visibility mechanism similar to `friend` or `InternalsVisibleTo`
还没有人认领这个 Issue。
- 主要语言
- Go
- 星标
- 111k
- 派生
- 14.3k
- 平均合并
- 1 天 19 小时
- 30 天内合并 PR
- 117
描述
Suggestion
A way to allow certain other modules to access properties or methods of a class.
Use Cases
Sometimes, we want other modules (other code) to have access to certain properties or methods, but otherwise the end user not to have access to the properties/methods. This is labeled as "package protected" or similar terms in other languages.
Examples
This is how it could work, with some sort of new non-runtime syntax:
import SomeClass from './SomeClass'
export class Foo {
visible in SomeClass
private foo: number = 123
}
or
import SomeClass from './SomeClass'
export class Foo {
private foo visible in SomeClass: number = 123
}
or maybe even as a special decorator, globally-declared, virtual decorator
import SomeClass from './SomeClass'
export class Foo {
@visibleIn(SomeClass)
private foo: number = 123
}
SomeClass would then be able to access the private property/method:
import {Foo} from './Foo'
export class SomeClass {
doSomethingWithFoo(o: Foo) {
console.log(o.foo) // OK, no type error.
}
}
The code inside of SomeClass could be allowed to access the private properties. This is great at design time when the author controls the source for both sides, but still wants to hide private parts from the end user on the outside of the APIs.
This allows for patterns like object managers being able to control certain aspects of the objects they manage (for example a renderer in a game engine that manages how objects in a scene render, and the renderable properties that the engine manager accesses, which are private to the end user) are composed from reactions to changes in the objects' public APIs by end users).
At the moment, the only way to allow objects to access properties of other objects is to make them public, but this does not allow for us to hide (at least in the type system) certain implementation details of a cross-class or cross-module whole system from the end user.
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.
- I'm not sure about this. This feature wouldn't change semantics of JavaScript, or add any JavaScript features, but would only add additional type capabilities to limit use of APIs in certain ways. In plain JS, before I ported a JavaScript project to TypeScript, I had an object manager that accessed properties prefixed with
__to denote that the properties were not to be used by the end user. The engine accessed the properties for internal implementation of the system.
- I'm not sure about this. This feature wouldn't change semantics of JavaScript, or add any JavaScript features, but would only add additional type capabilities to limit use of APIs in certain ways. In plain JS, before I ported a JavaScript project to TypeScript, I had an object manager that accessed properties prefixed with
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
调研方向
首先审查 TypeScript 现有的 private-member 可见性规则,以及 issue 中链接的设计目标。该提案没有确定实现文件、测试或已定稿的语法;在实现和测试能够确认完成之前,首先需要定义语法、模块访问语义和类型检查行为。
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- typescript
- 领域
- compilers
- Issue 类型
- 功能
- 难度
- 5/5
- 预计耗时
- 一周以上
- 活跃度
- 停滞
- 描述清晰度
- 需要澄清
- 新手友好度
- 20/100