microsoft / microsoft/TypeScript
[ID-Prep] Preserve type nodes from function expressions in initialisers
Open
Nobody has claimed this yet.
Committed
Suggestion
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
🔍 Search Terms
declaration emit preserve types from functions
✅ Viability Checklist
- 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, new syntax sugar for JS, etc.)
- This isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
⭐ Suggestion
Preserve types from function expressions in initializers when emitting declarations.
📃 Motivating Example
// index.ts
type P = {} & { foo: boolean };
export let fn = (p: P, p2:typeof p) => {}
// index-current.d.ts
type P = {} & { foo: boolean };
export declare let fn: (p: P, p2: {
foo: boolean;
}) => void;
export {};
// index-proposed.d.ts
type P = {} & { foo: boolean };
export declare let fn: (p: P, p2: typeof p2) => void;
export {};
💻 Use Cases
- What do you want to use this for?
This would improvement would can bring us closer to external declaration emitters being a reality. - What shortcomings exist with current approaches?
An external tool can extract the type from the function expression, but then they would have different declarations. It would be great if, where possible, typescript would also preserve types as written. - What workarounds are you using in the meantime?
We could force users to always specify the type even when it's obvious from the function expression, but this makes for very frustrating DX
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No source files, tests, or entry points are named. Reproduce the motivating example and inspect TypeScript's declaration emit behavior; done means function-expression initializer types are preserved as written in the emitted declaration without changing JavaScript 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