microsoft / microsoft/TypeScript
Recognize property with name defined by constant in Object.defineProperty
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
defineProperty
https://github.com/microsoft/TypeScript/issues/28694 is touching same domain
Suggestion
(Note: I'm using TS in JS files, have basically no knowledge about "pure" TS)
Compiler should recognize prototype property added using Object.defineProperty with name defined not only by string constant but also a string variable, e.g.:
const propName = 'myProp';
Object.defineProperty(Test.prototype, propName, { get: () => 'myVal' });
Playground Link
(included also desired behavior for decorators, but as it's experimental feature, you won't propably even consider it)
I understand it's not always possible to make sure variable with property name is not reassigned during runtime, but it seems that TS compiler can handle detection of "static" variables that have known value during compilation.
Use Cases
This way we could define class properties using "single source" and not duplicating code. For example a class providing access to key-value pairs object in a dotted notation instead of string values for keys, whilst the object can be used for another purpose.
Examples
// i can use these somewhere else, e.g. as a type
export const defaults = {
one: 1,
two: 2
}
// properties added in defineProperty
export class Test {
// i don't want to repeat myself
one = defaults.one;
/** @param {keyof defaults} key */
get(key) {
return defaults[key];
}
}
Object.keys(defaults).forEach((key) =>
Object.defineProperty(Test.prototype, key, { get: () => defaults[key] })
);
const inst = new Test();
inst.one; // who would not like this?
inst.get('one'); // instead of this
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 examiner comment le compilateur TypeScript gère les appels à Object.defineProperty et les noms de propriétés dérivés de constantes ou de variables. Comparez le comportement demandé avec l’issue #28694 ainsi qu’avec les exemples JavaScript et les liens vers le playground ; le travail est considéré comme terminé lorsque les propriétés de prototype reconnues reçoivent les informations de type attendues sans modifier le JavaScript émis.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- javascript, 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