microsoft / microsoft/TypeScript
Explain why private and protected members in a class affect their compatibility
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
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 (!)
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Private and Protected Members in Classes section of pages/Type Compatibility.md and read the linked issue comment for the existing rationale. Compare that explanation with the mock example and the requested alternatives. Done means either the rationale is documented clearly or the language-design question receives a recorded decision.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100