microsoft / microsoft/TypeScript

refactoring for extracting return type of a function

Ouverte
#35,467 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

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

Description

Search terms

refactoring extract return type function method interface inferred

Suggestion

A new refactoring for function expressions that extracts the return type of the function as an interface or type.

Use Cases

Imagine a complex function that combines many types of data into a complex object. Compiler can infer the return type, but writing it out by hand takes time. Type needs a name when you want to use it elsewhere in the code (for example as a parameter type for another function).

Examples

Imagine A, B, C, D are non trivial types. (e.g. objects with many properties)

before:

function fooFunc(a: A, b: B, c: C, d: D) {
  return {
    ...a,
    ...b,
    foo: {...c, d}
  }
}

after:

type FooFuncReturn = A & B & { foo: C & D }
// or when possible an interface type with would be even better

function fooFunc(a: A, b: B, c: C, d: D): FooFuncReturn {
  return {
    ...a,
    ...b,
    foo: {...c, d}
  }
}

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

L’issue ne nomme aucun fichier, test ni point d’entrée. Commencez par localiser l’infrastructure de refactorisation existante de TypeScript, puis définissez comment l’extraction demandée du type de retour doit gérer les formes de type et d’interface de l’exemple ; le travail est considéré comme terminé lorsque la refactorisation fonctionne pour le cas d’utilisation d’expression de fonction indiqué et que sa sortie est couverte par des tests.

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.