microsoft / microsoft/TypeScript
Proposal: Friend Declarations for classes
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 132
Beschreibung
NOTE: This proposal is an alternative to the proposal in #5228.
Overview
Often there is a need to share information on types within a program or package that should not be
accessed from outside of the program or package. While the public accessibility modifier allows
types to share information, is insufficient for this case as consumers of the package have access
to the information. While the private accessibility modifier prevents consumers of the package
from accessing information from the type, it is insufficient for this case as types within the
package also cannot access the information. To satisfy this case, we propose the addition of a FriendDeclaration to classes:
class A {
friend createA;
private constructor() { }
}
function createA() {
return new A();
}
A FriendDeclaration is a new declaration supported in the body of a ClassDeclaration or ClassExpression that indicates that the class, function, or namespace to which the supplied name resolves can treat the private and protected members of the class as if they were public.
The name referenced in the FriendDeclaration is resolved relative to the ClassDeclaration. The name must be in scope.
Grammar
ClassElement: ( Modified )
FriendDeclaration
FriendDeclaration:
friend FriendDeclarationNames ;
FriendDeclarationNames:
EntityName
FriendDeclarationNames , EntityName
Examples
Instantiate a class with a private constructor:
class A {
friend createA;
private constructor() { }
}
function createA() {
return new A();
}
Extend a class with a private constructor:
class A {
friend B;
private constructor() { }
}
class B extends A {
}
Access private members of an imported class:
// a.ts
import { update } from "./b";
export class A {
friend update;
private x: number;
}
// b.ts
import { A } from "./a";
export function update(a: A) {
a.x = 1;
}
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Der Issue nennt keine Dateien oder Tests. Beginne damit, diese Alternative mit Proposal #5228 zu vergleichen und die Grammatik und Beispiele anhand von TypeScripts Sprach- und Typprüfungskonzept zu validieren; abgeschlossen ist die Arbeit, wenn eine abgestimmte Implementierung von friend-Deklarationen vorliegt, die in den gezeigten Fällen den Zugriff auf private und protected abdeckt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- compilers
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 25/100