microsoft / microsoft/TypeScript
Explain why private and protected members in a class affect their compatibility
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
TypeScript Version: up to 2.5.2 at least
In the doc a short paragraph explains that private and protected members in a class affect their compatibility.
I have been searching for a while in the design goals, on SO etc... but could not find a decent explanation of the rationale. Could we:
- either document the rationale (in the paragraph above?
- or consider evolving the language?
Note: I found one rationale close to what I am looking for, but you could imagine that the language "reserves" the private names but does not compel to use them.
Code
This behavior is especially an issue in unit testing where you want to mock a class, disregarding its internals...
class MyClass {
pubfield = 0;
private privfield1 = 0;
constructor(private privfield2: number) {}
private method(): void {}
}
class MyClassMock implements MyClass {
pubfield: number;
// *** compile errors on missing properties ***
}
Expected behavior:
I would like to only care about the public contract that a class-under-test can possibly use from my mock.
Actual behavior:
I cannot limit my mock to the public fields.
The ugly workaround I found is the following:
class MyClass {
pubfield = 0;
private privfield1? = 0;
private privfield2? = 0;
// do not use the shortcut notation because the constructor param is not optional!
constructor(privfield2: number) {
this.privfield2 = privfield2;
}
private method?(): void {}
}
class MyClassMock implements MyClass {
pubfield: number;
}
What I do not like is that I have to modify the semantics of my class to be able to mock it and that I am scared that a future overzealous refactoring may use the shortcut notation for fields declaration in the constructor... making the constructor param optional (!)
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dalla sezione Private and Protected Members in Classes di pages/Type Compatibility.md e leggi il commento collegato della issue sulla motivazione esistente. Confronta questa spiegazione con l’esempio mock e le alternative richieste. Il lavoro è concluso quando la motivazione è documentata chiaramente oppure la questione di progettazione del linguaggio riceve una decisione registrata.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- compilers
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100