microsoft / microsoft/TypeScript

Allow to overwrite generic templates

Offen
#39,583 4 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Needs Proposal Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
132

Beschreibung

Search Terms

  • overwrite generic this type
  • overwrite template argument
  • class overwrite generic
  • overwrite type generic

Suggestion

Allow to overwrite generic type templates.

Use Cases

I'm currently developing a modular ORM and query builder, where especially in the query builder part it would be necessary to overwrite a generic template argument.

Examples

Here's a super simple example of a query builder. The select method should return a new instance of Query but with a different subset of T (since it limits the fields being selected).

interface Entity {}

class Query<T extends Entity> {
    findOne(): T;

    select(names: (keyof T)[]): this<Partial<T>>; //doesn't work
}

interface User {
    username: string;
    group: string;
    created: Date;
}

const item: User = new Query<User>().findOne();
const item: Partial<User> = new Query<User>().select(['username']).findOne();

This is just to demonstrate the use case. You could of course further describe the type of select by using Pick etc, but I wanted to keep it simple. Please note that I could return Query<Partial<T>> instead, but that would break class inheritance.

To my awareness this use case can't be covered with the newest TypeScript version.

Another use case I had:

interface Query<T> {
    findOne(): T;
}

interface AdapterInterface {
    createQuery<T extends Entity>(classType: Constructor<T>): Query<T>;
}

class Database<A extends AdapterInterface> {
    constructor (private adapter: A) {}

    // here is the magic with the return type, which doesn't work, but is necessary since
    // `T` of A['createQuery'] needs to be inferred from query<T>.
    query<T extends Entity>(classType: Constructor<T>): ReturnType<A['createQuery']><T> {
        return this.adapter.createQuery(classType);
    }
}

class MyAdapterQuery<T> extends Query<T> {
     additionalMethod(): this;
}

class MyAdapter {
    createQuery<T extends Entity>(classType: Constructor<T>): MyAdapterQuery<T> {
         return new MyAdapterQuery<T>();
    }
}


const database = new Database(new MyAdapter);
database.query(User).additionalMethod();

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit den generic-template-Beispielen im Issue und prüfe, wie TypeScript derzeit generische Klassen und Rückgabetypen von Methoden modelliert. Bestimme die beabsichtigte Semantik der Typprüfung und bewerte das erforderliche Compiler-Design, bevor du die Stellen für Implementierung und Tests identifizierst; abgeschlossen ist die Aufgabe, wenn die vorgeschlagenen Fälle eine Typprüfung bestehen, ohne das erzeugte JavaScript zu ändern.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
compilers
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.