microsoft / microsoft/TypeScript

Allowing subsequent property declarations of compatible types

Ouverte
#33,699 8 commentaires 7 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Needs Proposal Suggestion
Langage dominant
Go
Étoiles
111k
Forks
14.4k
Merge moyen
1 j 19 h
PR mergées (30 j)
117

Description

Search Terms

TS2717, subsequent property declarations

Suggestion

Let's assume following code:

Library typings:

interface Dictionary<T> {
   [key: string]: T;
}
interface Foo {
   methods: Dictionary<Function>;
}

User extension:

declare module "@awesome/library" {
     interface BagOfFunctions extends Dictionary<Function> {
         wellKnownFunction(foo: number): number;
     }
     
     interface Foo {
           methods: BagOfFunctions;
      }
}

Currently, it results in TS2717. After this change, such code will be allowed.

Use Cases

Use case: Hapi allow user to define global functions with shared cache (server.method).

Unfortunely, server.methods is currently defined as Dictionary<ServerMethod> and end users aren't able to get type safety when calling them.

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

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par le diagnostic TS2717 et le comportement de fusion des déclarations présenté dans les exemples. Comparez le rejet actuel de Foo.methods avec l’acceptation demandée de BagOfFunctions, puis définissez la couverture pour les redéclarations compatibles et incompatibles. C’est terminé lorsque l’extension d’exemple est acceptée sans affaiblir les erreurs de propriétés incompatibles.

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é
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.