microsoft / microsoft/TypeScript

Nominal/branded key for `Record` disables checking/inferring of value type

Offen
#43,852 6 Kommentare 6 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

In Discussion Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.3k
Ø Merge
2 T. 4 Std.
Gemergte PRs (30 T.)
132

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die verlinkte TypeScript-Playground-Reproduktion mit den Beispielen Record<Id, User> und Object.entries auszuführen, und vergleiche sie anschließend mit den funktionierenden Fällen Map und mit String-Schlüsseln versehenem Record. Verfolge, wie der Compiler gebrandete Schlüssel und Record-Werte verarbeitet; fertig ist die Untersuchung, wenn die Wertprüfung den fehlenden name meldet und Object.entries(users) User beibehält, statt unknown zu inferieren.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
compilers
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.