microsoft / microsoft/TypeScript
Allow using type parameters and return types with overloaded class constructors
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.4k
- Merge moyen
- 1 j 19 h
- PR mergées (30 j)
- 117
Description
Search Terms
Generic Class Constructor Declaration Overloads Type Parameters
Suggestion
This is partially a request to revisit some of the discussion from here:
https://github.com/microsoft/TypeScript/issues/10860
But it's also to provide some examples of cases that are difficult/impossible to type using classes today.
A class may frequently assign different types to its properties depending on how it was instantiated. While we can type those properties as unions of all their possible types (or even use completely separate classes), it would be amazing if we could "narrow" a class's type based on how it was instantiated.
We CAN handle this type of complexity with regular function overloads, because the relevant call signature is narrowed by both function parameters and type parameters. Class constructors, however, only pay attention to the parameters being passed and can't have type parameters.
Use Cases
// Using type parameters with overloaded generic function
function func(): void;
function func<T extends string>(requiredThing: T): void
function func(requiredThing?: string) { }
func() // Ok
func<'hello'>() // Expects 1 argument, as expected
// Attempting to use type parameters with overloaded class constructor
class Example<T> {
constructor()
constructor(blah: T) // How do we connect this to the presence of T?
constructor(blah?: T) {}
}
new Example() // Ok
new Example<'hello'>() // We want this to expect 1 argument somehow
As was also discussed in https://github.com/microsoft/TypeScript/issues/10860, return types on a constructor could theoretically represent narrowed versions of the instance type. Currently there's not an easy way to narrow a property's type based on how the class was instantiated:
class Example {
prop?: string | number
constructor() // When this is used, prop should be string | number | undefined
constructor(prop: string) // When this is used, prop should be string
constructor(prop: number) // When this is used, prop should be number
constructor(prop?: string | number) {
// implementation
}
}
Examples
Ideally, maybe something like this for narrowing by type parameters:
class Example {
constructor()
constructor<T extends string>(blah: T)
constructor(blah?: string) {}
}
new Example() // Ok
new Example<'hello'>() // Would expect 1 argument
And maybe something like this for return types:
interface IExampleString extends Example {
prop: string
}
interface IExampleNumber extends Example {
prop: number
}
class Example {
prop?: string | number
constructor() // When this is used, prop should be string | number | undefined
constructor(prop: string): IExampleString // When this is used, prop should be string
constructor(prop: number): IExampleNumber // When this is used, prop should be number
constructor(prop?: string | number) {
// implementation
}
}
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.
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Aucun fichier d’implémentation, test ou point d’entrée n’est indiqué. Commencez par examiner la discussion liée dans l’issue 10860 et les exemples de surcharge de constructeurs ici. Pour considérer le travail comme terminé, il faudrait s’accorder sur la sémantique et prendre en charge dans l’implémentation les paramètres de type et le resserrement du type de retour des constructeurs de classe surchargés, avec les tests correspondants.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- compilers
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 20/100