microsoft / microsoft/TypeScript
Nominal/branded key for `Record` disables checking/inferring of value type
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.4k
- Merge moyen
- 1 j 19 h
- PR mergées (30 j)
- 117
Description
Bug Report
🔎 Search Terms
nominal, Record, branded
🕗 Version & Regression Information
3.3.3 through 4.3.2
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about nominal types and record types
⏯ Playground Link
Playground link with relevant code
💻 Code
type Id = string & { __id: 'id' }
type User = {
id: Id;
name: string;
}
type Users = Record<Id, User>;
type Users2 = Map<Id, User>;
type Users3 = Record<string, User>;
// This will not produce an error
// @ts-expect-error No name should be an error!
const users: Users = { id0: { id: 'id', } }
// type: [string, unknown][]
const entries = Object.entries(users);
const users2: Users2 = new Map();
// @ts-expect-error No name produces an error
users2.set('id' as Id, { id: 'id' as Id, })
// @ts-expect-error No name produces an error
const users3: Users3 = { id0: { id: 'id' as Id, } }
// type: [string, User][]
const entries3 = Object.entries(users3);
🙁 Actual behavior
Using a nominal/branded type as the key to a record type causes type checking of the value to be skipped. Additionally, inference will also fail and fallback to unknown, such as using Object.entries. Using a Map works as expected, but not a Record. I realize that the runtime behavior between a Map (real) and Record (type) is completely different, I'm just providing it as an example.
🙂 Expected behavior
I'd expect types to be preserved and checked, even when using a nominal/branded type as a key to a record.
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 exécuter la reproduction liée dans TypeScript Playground avec les exemples Record<Id, User> et Object.entries, puis comparez-les aux cas fonctionnels Map et Record indexé par des clés de type string. Suivez le traitement des clés branded et des valeurs de record par le compilateur ; le travail est terminé lorsque la vérification des valeurs signale l'absence de name et que Object.entries(users) conserve User au lieu d'inférer unknown.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- compilers
- Type d'issue
- Bug
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 38/100