microsoft / microsoft/TypeScript
Private constructor type simplification produces incompatible type
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
🔎 Search Terms
private constructor incompatible parameter types removed
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about private constructor type simplification
⏯ Playground Link
💻 Code
// This class doesn't exist, it is just used as a convenient way for typing any class.
declare abstract class Constructable {
private constructor(...args: unknown[]);
}
// According to generated .d.ts, this looks exact same as Constructable
abstract class GeneratedConstructable {
private constructor() {}
}
export const funcThatAcceptsAnyClass = (clazz: typeof Constructable) => {};
export const funcThatAcceptsAnyGeneratedClass = (clazz: typeof GeneratedConstructable) => {};
class MyPrivateClass {
#privateVal: boolean;
private constructor(
public readonly foo: string,
public readonly bar: string
) {
this.#privateVal = true;
}
}
class MyPrivateClassWithNoParams {
#privateVal: boolean;
private constructor() {
this.#privateVal = true;
}
}
// This is what typescript sees at build time, its passing!
funcThatAcceptsAnyClass(MyPrivateClass);
funcThatAcceptsAnyClass(MyPrivateClassWithNoParams);
// This is what typescript sees when generated files are imported elsewhere, it fails!
funcThatAcceptsAnyGeneratedClass(MyPrivateClass);
funcThatAcceptsAnyGeneratedClass(MyPrivateClassWithNoParams);
🙁 Actual behavior
When a class contains a private constructor, the generated types file (.d.ts) strips the constructor down to the bare minimum, meaning any parameters are removed from the method.
This creates a type that is incompatible with the original type declaration.
Since it is only the result of generated code, it cannot be detected during build time. Instead it is caught when the types are referenced in a separate package.
🙂 Expected behavior
Either:
- Parameters are not stripped from private class constructors
- preferred
- Less likely to be breaking change
- Would produce slightly larger type files
- Private constructors are treated as parameter-less during build time
- Would not apply to "inside" the class (where private constructors can be legally called)
- Would at least produce consistent type behavior
Additional information about the issue
I stumbled across this issue when trying to restrict the type of a value to anything with a class.
Essentially the use case is a map of Class -> Instance. Restricting to "is a class" is important for instanceof checks. (I understand JS can technically call new on any function, but its 2024 and I think it is fair to restrict "class" behavior to the class keyword)
The implementation was not actually responsible for doing the instantiation, so private or abstract constructors are totally acceptable.
I have various type checks in the package itself, that behave entirely as expected.
However when I started using this package in another, suddenly I am hit with:
Argument of type 'typeof MyPrivateClass' is not assignable to parameter of type 'typeof GeneratedConstructable'.
Types of construct signatures are incompatible.
Type 'new (foo: string, bar: string) => MyPrivateClass' is not assignable to type 'abstract new () => GeneratedConstructable'.
Target signature provides too few arguments. Expected 2 or more, but got 0.
I would expect this kind of type behavior to either be caught during the original build time (second option in expected behavior) or to not implement this kind of constructor "simplifying" at all.
Perhaps it could be gated behind a compiler flag, because I can understand this is probably a fairly niche requirement. I understand in most cases, we use type comparisons against the instances, not the classes, and when using the classes a private constructor is an "internal" detail that usually does not expose it's functionality.
I would also accept an alternative to typeof Constructable.
The goal is to generate a type that effectively looks like private abstract new (...args: unknown[]) => any. However the private keyword is not allowed, and type matching fails on Cannot assign a 'private' constructor type to a 'public' constructor type
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 by reproducing the private-constructor example in the linked TypeScript Playground and compare the source declarations with the generated .d.ts output. Trace the declaration-generation path for private constructors, then make build-time and generated-type behavior consistent and add a regression test covering parameterized and parameterless private constructors.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100