Class mixins shouldn't require a specific signature of constructors
See original GitHub issueTypeScript Version: 2.2.0-dev.20170209
Code
Requiring mixins to have a constructor signature of constructor(...args: any[])
causes a few problems:
-
Node v4, which is an active LTS, doesn’t support rest and spread syntax. We avoid it and can run our output on Node v4 even when targeting ES6. The mixin constructor requirements prevent this.
-
It’s common to have mixins that want to provide a specific constructor. These will usually be applied last to create a concrete class. This is impossible now, so you have to create a new concrete class with only a constructor to give it the correct signature.
-
For a mixin that does have constructor argument requirements, it’s very cumbersome to extract arguments out of
...args
.
Here’s an approximation of a case I hit. I have two classes that that share a base class:
class Base {
foo: string[];
}
class A extends Base {}
class B extends Base {}
Later, I want to add some functionality to via mixins to create two new classes:
type Constructor<T extends object> = new (...args: any[]) => T;
interface Magic {}
const Magic = <T extends Constructor<Base>>(superclass: T): Constructor<Magic>& T =>
class extends superclass implements Magic {
constructor(foo: string[]) {
super();
this.foo = foo;
}
};
const MagicA = Magic(A);
const MagicB = Magic(A);
And I want MagicA and MagicA to have a constructor that takes a single argument. I know the code will work because I know the constructors of A and B, but the type checker is unhappy.
First, the Constructor
type is wrong in this case because I know the signature I want. I’d actually like to write:
type BaseConstructor = new() => Base;
type MagicConstructor = new(foo: string[]) => Magic;
interface Magic {}
const Magic = <T extends BaseConstructor>(superclass: T): MagicConstructor & T =>
class extends superclass implements Magic {
constructor(foo: string[]) {
super();
this.foo = foo;
}
};
const MagicA = Magic(A);
const MagicB = Magic(A);
Expected behavior:
This works
Actual behavior:
Error: “Type ‘T’ is not a constructor function type.” on the extends clause.
Issue Analytics
- State:
- Created 7 years ago
- Reactions:14
- Comments:5 (1 by maintainers)
Top GitHub Comments
+1 - imho there are many use cases for this. If you need a flexible, but feature-rich mixin, you often need to specify the (constructor)-dependencies of classes using your mixin. You want to restrict your mixin to only a group of classes, for example to controller classes, and would like to access a property like the current user, without forcing the super state to contain this property. Especially if the mixin is imported from a library, you really don’t want to force the library’s user to change his parental class structure in order to use the mixin.
@trusktr With type assertions anything is possible 😊. This works well for the users of the mixin (although authoring the mixin is a bit of dark magic):