question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Class mixins shouldn't require a specific signature of constructors

See original GitHub issue

TypeScript Version: 2.2.0-dev.20170209

Code

Requiring mixins to have a constructor signature of constructor(...args: any[]) causes a few problems:

  1. 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.

  2. 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.

  3. 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:open
  • Created 7 years ago
  • Reactions:14
  • Comments:5 (1 by maintainers)

github_iconTop GitHub Comments

4reactions
antoniusostermanncommented, Jan 26, 2018

+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.

3reactions
dragomirtitiancommented, Jun 20, 2019

@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):

type ComposeConstrucrtor<T, U> = 
    [T, U] extends [new (a: infer O1) => infer R1,new (a: infer O2) => infer R2] ? {
        new (o: O1 & O2): R1 & R2
    } & Pick<T, keyof T> & Pick<U, keyof U> : never
    
function Foo<T extends new (o: any) => any>(Base: T) {
    class Foo extends (Base as new (...a: any[]) => {}) {
        constructor(options: { foo: string }) {
            super(options)
            console.log(options.foo)
        }
        foo() {}
        static foo() {}
    }
    return Foo as ComposeConstrucrtor<typeof Foo, T>
}

function Bar<T extends new (o: any) => any>(Base: T) {
    class Bar extends (Base as new (...a: any[]) => {}) {
        constructor(options: { bar: string }) {
            super(options)
            console.log(options.bar)
        }
        bar() {}
        static bar() {}
    }

    return Bar as ComposeConstrucrtor<typeof Bar, T>
}

class Baz extends Foo(Bar(class { }))  {
    constructor(options: { foo: string, bar: string, whatever: string }) {
        super(options)
        console.log(options.whatever)
    }
    baz() {}
    static baz() {}
}
let baz = new Baz({ bar: "", foo: "", whatever: ""});
baz.bar();
baz.baz();
baz.foo()

Baz.foo();
Baz.bar();
Baz.baz();
Read more comments on GitHub >

github_iconTop Results From Across the Web

why do typescript mixins require a constructor with a single ...
Based on the way mixins are implemented, a mixin is not able to restrict the constructor signature of the base such that it...
Read more >
Mixin Classes in TypeScript - Marius Schulz
The reason for this is that the mixin should not be tied to a specific class with known constructor parameters; therefore the mixin...
Read more >
Multiple inheritance and mixin classes in Python
When an object needs a specific feature it just delegates it to another class ... all the classes that are specified in the...
Read more >
TypeScript: Implementing Mixin Pattern - United States (English)
Mixin helps to implement Dependency inversion principle · High-level modules should not directly depend on low-level modules; instead, both ...
Read more >
A tour of the Dart language
Using null safety requires a language version of at least 2.12. ... The Object , Object? , Null , and Never classes have...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found