microsoft / microsoft/TypeScript
Add feature to re-declare variable
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.3k
- Merge moyen
- 2 j 4 h
- PR mergées (30 j)
- 132
Description
Search Terms
redeclare variable, re-declare variable, augment variable, merge variable declaration, declaration override
Suggestion
define a redeclare keyword which allows re-declaration of a typed variable.
e.g.
redeclare var foo: {
prop: string
};
Use Cases
When an external library declares a variable, e.g.
declare var x: {
prop: string;
};
The redeclare keyword can be used somewhere else to override the declaration:
redeclare var x: number;
or augment it:
redeclare var x: typeof x & {
augmentedProp: number;
}
This would allow to type the pure JavaScript case of:
// lib.js
var x = {
prop: "foo"
};
// app.js
x.augmentedProp = 10;
console.log(x.prop, x.augmentedProp);
Examples
declare var URLSearchParams: { prototype: URLSearchParams; new(init?: string[][] | Record<string, string> | string | URLSearchParams): URLSearchParams; toString(): string; };defined in
lib.dom.d.ts
to extend the variable with additional static methods to URLSearchParams is not possible currently (see here).
The feature can be used in the following way:
redeclare var URLSearchParams: typeof URLSearchParams & {
fromObject(obj: object): URLSearchParams;
};
if (!URLSearchParams.fromObject) {
URLSearchParams.fromObject = function(obj: object): URLSearchParams { /* implementation */ }
}
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
- 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.
Piste de recherche
Commencez par les exemples proposés de redeclare et la déclaration existante dans lib/lib.dom.d.ts, en particulier le cas URLSearchParams. Examinez la manière dont TypeScript gère actuellement les déclarations de variables globales et les augmentations, puis définissez le comportement pour la surcharge et la fusion des déclarations. Le travail sera considéré comme terminé lorsque la proposition aura établi la sémantique et que des tests du compilateur correspondants couvriront les exemples.
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
- 25/100