microsoft / microsoft/TypeScript

better autocompletion for dicriminated union as tuples

Aperta
#31,977 0 commenti 7 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Experience Enhancement Suggestion
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

Search Terms

autocompletion, tuple, tagged union

Suggestion

Use Cases

https://www.typescriptlang.org/docs/handbook/advanced-types.html#discriminated-unions
Discriminated unions of tuples is just the same in semantic with discriminated unions with object introduced in the official document of typescript.
And the type check for it is working correctly for now.
But the autocompletion for tuples isn't as powerful as one for objects.
Sometimes discriminate unions as objects are verbose so it leads us to write some sort of constructors for each variant. But tuples can solve this problem, and it even looks more similar to haskell's data and rust's enum.

Examples

// discriminated union as tuples
type A = ["a", { a: number }] | ["b": { b: number }];
const a: A = ["a", { /* both a and b are suggested when you fill in here */ }];
const b: A = ["b", { a: 1 }]; // type check works correctly! typescript tell us it's invalid.

// discriminated union as objects
type C = {
    tag: "a",
    a: number
} | {
    tag: "b",
    b: number
};
const c: C = { tag: "b", /* only b is suggested! */ };

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalla sezione «discriminated-unions» del manuale di TypeScript collegato nell’issue e confronta gli esempi di tuple e oggetti. Il lavoro è completato quando le unioni discriminate basate su tuple forniscono il completamento automatico specifico per variante come la forma a oggetto, preservando al contempo il comportamento esistente del controllo dei tipi.

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
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.