microsoft / microsoft/TypeScript
Branded literal type widened in unexpected way
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
🔎 Search Terms
literal intersection branded string
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about branded strings/literal intersections.
⏯ Playground Link
💻 Code
declare const typeKey: unique symbol;
type TypeID<Type = unknown, ID extends string = string> = ID & { [typeKey]?: Type };
function typeID<Type, ID extends string>(id: ID): TypeID<Type, ID> {
return id;
}
type KeyOf<TID extends TypeID> = TID extends TypeID<any, infer ID> ? ID : never;
type TypeOf<TID extends TypeID> = TID extends TypeID<infer Type> ? Type : never;
type Provides<P extends TypeID> = { readonly [T in KeyOf<P>]: TypeOf<P> };
// ---cut---
interface Foo {
foo(): void;
}
const Foo = typeID("Foo") satisfies TypeID<Foo>;
// ^? const Foo: TypeID<Foo, "Foo">
const Bar: Provides<typeof Foo> = {
[Foo]: {
foo() {}
}
};
🙁 Actual behavior
Fails to compile with error:
Property 'Foo' is missing in type '{ [x: string]: { foo(): void; }; }' but required in type 'Provides<TypeID<Foo, "Foo">>'.
🙂 Expected behavior
I'd expect it to compile. Rather than widening the literal type to string, I'd expect it to discard the { [typeKey]?: Type } part, since that's pretty much bogus at runtime anyway.
However, it should also not lose the type information for the generic types. For instance, if I change the declaration to...
type TypeID<Type = unknown, ID extends string = string> = ID;
...then it does compile, but so does this...
const Bar: Provides<typeof Foo> = {
[Foo]: {
// No error about missing member `foo` here!
}
};
Additional information about the issue
Possibly related to https://github.com/microsoft/TypeScript/issues/43852#issuecomment-1671115898
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 la riproduzione in TypeScript Playground e confronta il comportamento dei branded literal con la discussione correlata nell’issue #43852. Traccia il percorso del controllo dei tipi per le definizioni TypeID, KeyOf, TypeOf e Provides; il lavoro è completato quando l’esempio viene compilato continuando a segnalare un membro foo mancante quando appropriato.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- compilers, devtools
- Tipo di issue
- Bug
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100