microsoft / microsoft/TypeScript
Need way to express hybrid types that are indexable for a subset of properties
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
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!
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia con gli esempi di CSSProperties e le indicazioni del handbook collegate, quindi riproduci il comportamento attuale del type-checker per proprietà esplicite combinate con una index signature. Il lavoro sarà completato quando sarà possibile esprimere il tipo ibrido richiesto rifiutando al contempo le proprietà sconosciute con tipi incompatibili, senza affidarsi all'unsound union workaround.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- compilers
- Tipo di issue
- Funzionalità
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 28/100