microsoft / microsoft/TypeScript

refactoring for extracting return type of a function

Open
#35,467 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or entry points. Start by locating TypeScript's existing refactoring infrastructure, then define how the requested return-type extraction should handle the example's type and interface forms; done means the refactoring works for the stated function-expression use case with coverage for its output.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.