microsoft / microsoft/TypeScript
Strict version of Extract for literal union types
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
Search Terms
extract, pick, union, literal, string
Suggestion
Currently we have Pick<T, K> to select a type-safe subset of a given type T using a union of keys K. Unfortunately this does not work for unions of literals and requires Extract which subjectively isn't strict enough:
type ShirtSizes = "xxxl" | "xxl" | "xl" | "l" | "m" | "s" | "xs" | "xxs";
type Subset = Extract<ShirtSizes, "l" | "m" | "s" | "this-is-allowed-as-well">;
One caveat is that Extract does not support code completion when writing the literal union for the keys and it allows keys not in the first type as well. The former is error-prone while the latter is not causing a different behavior since the illegal keys are ignored but it can't be strictly checked in the long run. Of course I understand there are use cases wherein you'd like to use Extract more liberally so the definition
type Extract<T, U> = T extends U ? T : never;
is reasonable enough. Nevertheless, I'd like to propose an additional strict variant as follows
// short-hand form
type ExtractStrict<T, U extends T> = Extract<T, U>;
// equivalent full form
type ExtractStrict<T, U extends T> = T extends U ? T : never;
Use Cases
type ShirtSizes = "xxxl" | "xxl" | "xl" | "l" | "m" | "s" | "xs" | "xxs";
// this allows for code completion
type Subset = ExtractStrict<ShirtSizes, "l" | "m" | "s">;
// this is causing an error
type Subset2 = ExtractStrict<ShirtSizes, "l" | "m" | "s" | "illegal-literal">;
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der Prüfung des vorhandenen Extract-Hilfstypen und der ShirtSizes-Beispiele des Issues. Ermittle, wie eine strikte Variante in das Design des TypeScript-Typsystems und das Testverhalten passen würde, einschließlich der Ablehnung unzulässiger Literale und der Unterstützung der Vervollständigung. Erledigt bedeutet, dass der vorgeschlagene Typ spezifiziert, implementiert und durch Compiler-Tests abgedeckt ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- compilers
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100