microsoft / microsoft/TypeScript

Allowing subsequent property declarations of compatible types

Offen
#33,699 8 Kommentare 7 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
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

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.

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 der TS2717-Diagnose und dem in den Beispielen gezeigten Verhalten beim Zusammenführen von Deklarationen. Vergleiche die aktuelle Ablehnung von Foo.methods mit der angeforderten Akzeptanz von BagOfFunctions, und definiere anschließend die Abdeckung für kompatible und inkompatible Neudeklarationen. Fertig ist die Änderung, wenn die Beispielerweiterung akzeptiert wird, ohne die Fehler für inkompatible Eigenschaften abzuschwächen.

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
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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