microsoft / microsoft/TypeScript
Need way to express hybrid types that are indexable for a subset of properties
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 2 d 4 h
- PR fusionados (30 d)
- 132
Descripción
Edit by @DanielRosenwasser: This might be thought of as a "rest index signature" or a catch-all index signature.
This is a feature request.
TypeScript Version: 2.4
Code
interface CSSProperties {
marginLeft?: string | number
[key: string]: CSSProperties
}
Based on the docs, this is not allowed:
While string index signatures are a powerful way to describe the “dictionary” pattern, they also enforce that all properties match their return type. This is because a string index declares that obj.property is also available as obj[“property”]. In the following example, name’s type does not match the string index’s type, and the type-checker gives an error:
Unfortunately, it seems to make this type (which is common amongst jss-in-css solutions) not expressible. Coming from flow, which handles index types by assuming they refer to the properties that are not explicitly typed, this is frustrating.
As it stands, you can workaround it with:
interface CSSProperties {
marginLeft?: string | number
[key: string]: CSSProperties | string | number
}
But this is not sound. It allows this:
const style: CSSProperties = {
margarineLeft: 3
}
This could potentially be solved with subtraction types if they allowed subtracting from string (and you were allowed to specify key types in this way):
interface CSSProperties {
marginLeft?: string | number
}
interface NestedCSSProperties extends CSSProperties {
[key: string - keyof CSSProperties]: CSSProperties
}
I asked about this on stackoverflow to confirm that I wasn't missing something. It seems I'm not, so I guess I'd consider this a suggestion/discussion starter, since it's probably not a "bug". Thanks!
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con los ejemplos de CSSProperties y las directrices del handbook enlazadas; después, reproduce el comportamiento actual del type-checker para propiedades explícitas combinadas con una index signature. La tarea estará terminada cuando el tipo híbrido solicitado pueda expresarse y, al mismo tiempo, se rechacen las propiedades desconocidas con tipos incompatibles, sin depender de la solución alternativa de union unsound.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- compilers
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 28/100