microsoft / microsoft/TypeScript
Suggestion: Use typeof of declaration to define its type
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
- infer variable declaration
- typeof declaration
- using typeof on current expression
- apply modifier to declaration
- generic declarations
Suggestion
I would like to use current declaration type for modifying type of variable, I'm creating, e.g.:
const foo: Readonly<typeof var> = {
bar: 'baz',
}
Maybe, there is a better syntax, that I couldn't think of.
Use Cases
Typescript infer rather narrow type from variable declaration by default, which is a good thing. Sometimes we want to widen it, so it can fit into our interfaces. Mostly, it can be done by simply declaring a variable of certain type. But sometimes, it's useful to create some object along the way and somehow extend it's inferred type(some libraries can export very complicated generic types, so explicitly writing them could be a pain)
My specific use case was caused by reselect library, when I tried to reuse some selectors.
// typeof selectors is (selector1ReturnType | selector2ReturnType | selector3ReturnType)[]
const selectors = [
state => someSelector1(state),
state => someSelector2(state),
state => someSelector3(state),
]
But this array of selectors couldn't be used in createSelector function, cause it is expecting a tuple of selectors, to correctly infer type of arguments of selector function. I tried to use as const on my declaration, but it leaded to another error, cause createSelector expects a mutable tuple(it's only a type thing, not that it really mutates the selectors, but I'm afraid, this is a really common case in all library typings, not to mark it's arguments as readonly). I also found a solution for creating tuples with function, but I don't like the fact, that static typings require some(even tiny) runtime overhead, also the solution is not generic.
For now, I ended up with something like this, using Writable type from this docs:
const selectorsConst = [
state => someSelector1(state),
state => someSelector2(state),
state => someSelector3(state),
] as const
const selectors: Writable<typeof selectorsConst> = selectorsConst as any
But this solution is not pretty also. I wanted it to look like this:
const selectorsConst: Writable<typeof var> = [
state => someSelector1(state),
state => someSelector2(state),
state => someSelector3(state),
] as const
Or even something like this(but this is out of scope of this issue):
const selectorsConst: Tuple<typeof var> = [
state => someSelector1(state),
state => someSelector2(state),
state => someSelector3(state),
]
Examples
Making a Readonly, Partial, Writable, etc. object:
const foo: Partial<typeof var> = {
bar: {
baz: 'value',
},
}
foo.bar.baz = 'new value' // Error: Object is possibly 'undefined'
Unifying object values types:
interface MyClass {
bar?: string;
baz?: string;
}
const foo: {
[key in keyof typeof var]: MyClass;
} = {
firstEntry: { bar: 'bar' },
secondEntry: { baz: 'baz' },
}
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
Aucun fichier, test ni point d’entrée n’est nommé. Commencez par examiner comment TypeScript représente les requêtes typeof, les annotations de type des déclarations, les mapped types et l’inférence des tuples, puis définissez la syntaxe acceptée et son comportement de vérification des types ; la tâche est terminée lorsque la proposition dispose d’une conception approuvée et des tests correspondants du compilateur.
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é
- À clarifier
- Accessibilité débutants
- 25/100