microsoft / microsoft/TypeScript

Extract function parameters or change function return type in mapped types

Offen
#24,068 5 Kommentare 8 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

Search Terms

extract function parameters
change function return type

Suggestion

Allow mapped types to change the return type of a function

Use Cases

I am writing a mocking framework. My system under test might be like this:

MyClass{
    myClassFunction(paramOne: string, paramTwo: number): string{}
}

but in my mocking framework I want to do this:

mockedObject
    .withFunction("myClassFunction")
    .withParameters("paramOneValue", 123)
   .wasCalled();

to do the withParameters I need to type a function with the same parameters as defined on my class but with a different return type.

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. new expression-level syntax)

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 damit, die Fähigkeiten von TypeScript in Bezug auf mapped types und function types anhand des mocking-framework-Beispiels zu untersuchen. Ermittle, wie die Extraktion von Parametern und das Ersetzen des Rückgabetyps ausgedrückt werden sollten, während das bestehende Verhalten von TypeScript und JavaScript erhalten bleibt. Als erledigt gilt die Aufgabe, wenn die angeforderte Typtransformation unterstützt wird und die Parameter der mockten Funktion im Beispiel korrekt geprüft werden.

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
25/100

Neue Issues direkt in Ihr Postfach

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