microsoft / microsoft/TypeScript
Preserve interfaces in generated declaration files for augmentation
@weswigham y travaille déjà.
Depuis le 18/2/2021.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.4k
- Merge moyen
- 1 j 19 h
- PR mergées (30 j)
- 117
Description
Suggestion
2023 Updat
We investigated this, and turns out its easy to workaround, just extract function's type into standalone type declaration. So its low priority for us now.
🔍 Search Terms
Stop emitting never for empty interfaces from declaration
✅ Viability 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, new syntax sugar for JS, etc.)
- [ X This feature would agree with the rest of TypeScript's Design Goals.
⭐ Suggestion
Make TypeScript compiler preserve references to original Interfaces. (or at very least add an option for this!)
📃 Motivating Example
export interface InterfaceToAugment {
}
export default <T extends keyof InterfaceToAugment>(key: T, value: InterfaceToAugment[T]) => { };
After we run tsc (with declaration: true of course) we'll see our .d.ts file:
export interface InterfaceToAugment {
}
declare const _default: <T extends never>(key: T, value: InterfaceToAugment[T]) => void;
export default _default;
As you can see here, declaration file making this interface absolutely useless., but I wanted to make this function to pick real keys of this interface.
Is there any workaround for this?
💻 Use Cases
Module Augmentation for library consumer
declare module "this-lib" {
interface InterfaceToAugment {
myCustomKey: 5
}
}
Please, correct me if I missed something
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Évaluation
Cette issue n'a pas encore été évaluée.